systemdokumentasjon

Systemdokumentasjon er dokumentasjon som beskriver et systems oppbygging, bestanddeler, funksjonalitet og operasjon. Den er rettet mot utviklere, driftspersonell og andre interessenter, og har som mål å gjøre systemet forståelig, vedlikeholdbart og etterprøvbart.

Omfang og innhold

Omfanget av systemdokumentasjon inkluderer arkitektur og komponenter, installasjon og oppsett, konfigurasjon og drift, overvåking, logging og ytelse, samt sikkerhet og tilgangskontroll. Den dekker også feilsøking og prosedyrebeskrivelser, API-er og grensesnitt, datamodeller, migrasjoner, backup og katastrofeberedskap, endringslogg og historikk, samt brukerveiledninger og operatørguider.

Formater og verktøy

Dokumentasjonen kan være i flere formater, ofte tekstbaserte som Markdown, reStructuredText eller AsciiDoc. Diagrammer og modeller kan illustreres med UML eller PlantUML for å tydeliggjøre arkitektur og dataflyt. Generering av dokumentasjon skjer ofte med verktøy som Sphinx, Doxygen eller Javadoc, og dokumentasjonen kobles tett til kildekoden i et versjonskontrollsystem som Git, slik at den kan være levende og oppdatert i takt med programvaren.

Kvalitet og forvaltning

Kvaliteten av systemdokumentasjon avhenger av klart eierskap, regelmessige gjennomganger og oppdateringer ved endringer i systemet. Dokumentasjonen bør være konsistent, heltallig og lett tilgjengelig, med klare koblinger til kode, tester og driftshåndbøker. God forvaltning sikrer at dokumentasjonen følger devops- eller språkspesifikke standarder og støtter kunnskapsdeling i organisasjonen.