Utskriftsvennlig versjon
<< Tilbake

Dokumentasjonsstandard til systemutviklingsprosjekt

Situasjon Bydelsprosjektet hadde behov for en egen dokumentasjonsstandard, DataPed as utarbeidet standarden og sørget siden for at standarden ble fulgt gjennom en egen redaktørfunksjon.
 
Kritiske punkt Prosjektledelsen var redd for at dokumentasjonen skulle bli rotete og mangelfull og vanskelig å bruke. Det var viktig at brukerne var fornøyde med systemet, og dokumentasjonen var en viktig del av bildet.
 
Årsaker Utviklerne kom fra ulike miljøer og skulle selv skrive dokumentasjonen til systemene de utviklet. De ansattes representanter skulle være med å skrive brukerdokumentasjonen. Erfaringen med systemutviklere og dokumentasjon var blandet, og de ansattes representanter hadde ingen erfaring med å skrive brukerdokumentasjon.
 
Visjon

En ryddig og god brukerdokumentasjon ville bidra til at brukerne ble positive til systemene. En tilsvarende oversiktlig systemdokumentasjon ville gjøre det enklere å ta over og videreutvikle og vedlikeholde systemene.

Dette krevde en dokumentasjonsstandard som var enkel å følge og detaljert nok til å gi et gjenkjennelig preg.
 

Vi leverte

Vi lagde en dokumentasjonsstandard som omfattet en liten designguide, og som kune brukes på all dokumentasjon fra delprosjektet.

Deretter ble vi engasjert som redaksjon for å følge opp dokumentasjonsarbeidet og redigere dokumentasjonen etter hvert som arbeidet skred fram.

Vi fikk dessuten ansvar for å bygge opp og drive et arkiv. I tillegg skrev vi selv brukerdokumentasjon til et par relaterte IT-system.
 

Resultat

Dokumentasjonen fra delprosjektet var komplett da det ble avsluttet. Brukerne uttrykte at de var fornøyde med brukerdokumentasjonen som var oppgaveorientert og lett å bruke.

Systemdokumentasjon var også på plass i arkivet, og dette var ryddig og dokumentert slik at andre kunne overta.