Fagstoff

Planlegg dokumentasjonen

Publisert: 24.09.2013, Oppdatert: 05.03.2017
  • Innbygg
  • Enkel visning
  • Lytt til tekst
  • Skriv ut
Arbeid på bærbar pc

God planlegging er alltid viktig. Hva bør dokumenteres, og hvordan skal det presenteres? Hvor detaljert er det nødvendig at systemdokumentasjonen er?

Dokumentasjon er kommunikasjon. Sørg derfor for at dokumentasjonen er forståelig for andre!Dokumentasjon er kommunikasjon. Sørg derfor for at dokumentasjonen er forståelig for andre!

Dokumentasjon = kommunikasjon

Å dokumentere et system kan kreve litt planlegging. Dokumentasjon er først og fremst en kommunikasjonsoppgave. Du skal dokumentere teknisk informasjon om et system på en slik måte at du seinere enkelt kan finne tilbake til den informasjonen du trenger, og slik at andre skal kunne lese og forstå den. Det er ikke sikkert at det som er opplagt for deg, er opplagt for en annen ansatt som skal bruke dokumentasjonen seinere.

Detaljnivå

Samtidig må ikke systemdokumentasjonen bli så detaljert og omfattende at det blir håpløst å finne den informasjonen man trenger. Husk også at dokumentasjonen må oppdateres hver gang det skjer endringer. Hvis detaljnivået blir for høyt, blir oppdateringsjobben også tilsvarende stor.

Du må derfor tenke igjennom hva som bør dokumenteres, og hvordan informasjonen bør presenteres, slik at dokumentasjonen blir enkel å bruke og å vedlikeholde.

Tenk over

Hva hadde du trengt å vite hvis du skulle overta ansvaret for et system som du ikke kjente fra før? Det er dette du bør dokumentere.

 

Gjør litt av dokumentasjonen hver dag - så blir jobben mer overkommelig.Gjør litt av dokumentasjonen hver dag - så blir jobben mer overkommelig.

Litt er bedre enn ingenting!

Det kan virke overveldende å ta fatt på en systemdokumentasjon. Noen kommer aldri i gang fordi de er usikre på hvor de skal begynne, eller de er redde for at de ikke skal klare å gjøre det riktig. Men husk at selv en mangelfull dokumentasjon er bedre enn ingen dokumentasjon. Å dokumentere et IKT-system er også nyttig for å lære systemet bedre å kjenne.

Hvor lang tid det tar å dokumentere, er avhengig av størrelsen på og kompleksiteten til systemet. Det kan være lurt å sette av litt tid hver dag eller hver uke istedenfor å forsøke å gjøre hele jobben i en omgang.

Dokumentasjon er kommunikasjon og krever planlegging. Husk også at andre skal kunne bruke dokumentasjonen seinere.