Golf - Juniortävlingar

Dokumentationsportal

Dokumentationsportal

Syfte

Dokumentationsportalen är den inbyggda platsen för systemdokumentation, arkitekturprinciper, driftinformation, releaseprocess och utvecklingsprinciper för Golf - Juniortävlingar.

Princip

Dokumentationen ska vara en del av produkten. En utvecklare eller förvaltare ska kunna förstå systemets uppbyggnad och releaseflöde utan att behöva läsa tidigare chattar eller externa anteckningar.

Innehåll

Portalen organiserar dokumentationen i kategorier:

  • Översikt
  • System
  • Drift och release
  • Utveckling och kvalitet
  • Arkitektur
  • ADR

Framtida förbättringar

  • Sökning i dokumentation.
  • Automatisk systemstatus.
  • Metadata per dokument.
  • Versionshistorik kopplad till Git-taggar.
  • Administratörsgränssnitt med loggar, backup och diagnostik.