Permanent dokumentasjon
Når vi leverer fra oss et ferdig programsystem, må vi samtidig sørge for å levere tilstrekkelig dokumentasjon til at programsystemet kan leve et godt og langt liv i brukerorganisasjonen. Det er vanlig å kalle den dokumentasjonen vi leverer sammen med systemet for den permanente dokumentasjonen.
Hvilke krav stiller vi til denne dokumentasjonen? Den permanente dokumentasjonen skal bidra til at systemet brukes på riktig måte og at det oppfører seg som det skal, uten feil og mangler. Dokumentasjonen må derfor inneholde den informasjonen som er nødvendig for å kunne bruke systemet, for å kunne vedlikeholde systemet og for kunne å holde det i daglig drift. Informasjonen må i tillegg presenteres slik at målgruppene for dokumentasjonen forstår det som står der.
Når utvikler vi denne dokumentasjonen? Grunnlaget legger vi gjennom hele utviklingsløpet i de dokumentene vi produserer underveis, slik som kravspesifikasjon, designdokument, fysisk og logisk databasemodell etc. Det vi gjør i sluttfasen av prosjektet er å samle sammen og strukturere og omforme den dokumentasjonen vi har, med tanke på hvem som skal bruke den og den måten den skal brukes på etter at systemet er satt i drift.
Typer dokumentasjon. Vi skiller vanligvis mellom tre typer dokumentasjon, med forskjellig målgruppe:
Alle tre målgrupper skal ha en beskrivelse av systemet, men med så forskjellig bakgrunn og mål for hva de trenger dokumentasjon til, er det klart at de må ha tre forskjellige beskrivelser. Nedenfor har vi tatt med en anbefaling til mål og innhold for tre typer dokumentasjon, hentet fra Den Norske Dataforenings rapport serie: God IT-skikk, hefte nr 1 juni 2001: Dokumentasjon av IT-systemer. Dette er kortversjonen av anbefalingen. For flere detaljer enn det vi tar med her, henviser vi til den komplette rapporten som kan anskaffes fra dataforeningen. Hvis du ønsker å bla igjennom den, kontakt Greta Hjertø eller Else Lervik.
| Type | Hensikt | Innhold |
| Systemdokumentasjon: | Systemdokumentasjonen er primært beregnet på systemutviklere. IT-systemet skal beskrives tilstrekkelig detaljert til at forsvarlig systemforvaltning (vedlikehold og videreutvikling) muliggjøres. Systemdokumentasjonen skal gi innsikt i og forståelse av systemet. Den bør utformes slik at andre enn IT-personell kan forstå, godkjenne og delta i systemutviklingen |
|
| Driftsdokumentasjon: | Driftsdokumentasjonen er primært beregnet på driftspersonalet. Den er en beskrivelse av systemets oppbygging og driftsmønster for å sikre korrekt drift av IT-systemet, driftsmessig vedlikehold og stabilitet. |
|
| Brukerdokumentasjon | Brukerdokumentasjonen er primært beregnet på brukerne av systemet. Den skal på en oversiktlig og lettfattelig måte beskrive systemet med tilhørende manuelle rutiner slik det arter seg for brukeren. Hensikten er å sikre korrekt bruk av IT-systemet, og den skal kunne benyttes som oppslagsbok for brukerne. |
|