Jeg har opp igjennom tidene lært at god dokumentasjon er alfa—omega for å opprettholde stabil drift. De aller fleste konsulenter dokumenterer arbeidet de gjør, i alle fall dersom du ber om det, men ikke all dokumentasjonen har noe for seg.
Jeg mener det er to årsaker til at man skal dokumentere:
- Endringer i driftssituasjonen
- Systemgjenoppretting
Du trenger ikke dokumentasjon for noe annet enn dette, så alt annet kan etter min mening skrelles bort. Det ser kanskje banalt ut, men her er det utrolig mange som slurver.
Endringer i driftssituasjon
For å opprettholde stabil drift må du vite hvor innstillinger og filer er plassert og hvilke funksjoner de har, samt brukerkontoer, databaser og andre koblinger som benyttes. For å ta en tradisjonell klient–server applikasjon som bruker en database som eksempel, kan det være greit å ha dokumentasjon på følgende:
- Hvilken versjon er i bruk for øyeblikket?
- Hvilke komponenter og programmer må være på plass for at systemet skal fungere?
- Hvor ligger filene på klienten?
- Hvor ligger filene på server?
- Hva kreves av rettigheter for å bruke applikasjonen?
- Hvem har tilgang til programmet, og på hvilke måter?
- Hvor ligger databasen?
- Hvilke brukere, roller, eventuelt andre tilpasninger er gjort i databasen?
- Hvor finnes logger for programmet, og hvordan skal de tolkes?
- Hva brukes av minne, CPU og andre ressurser under vanlig drift?
Systemgjenoppretting
Når du tenker systemgjenoppretting, bør du se lenger enn bare backup. Dataene må kunne gjenopprettes også, ellers er sikkerhetskopien helt verdiløs. Noen ganger er det mulig du også får behov for å gjenopprette deler av et system, for eksempel deler av en database1. Da bør du kjenne til følgende:
- Hvor ligger sikkerhetskopien? Klarer du å finne den igjen ved et totalhavari?
- Hvor skal sikkerhetskopien gjenopprettes til?
- Hvordan verifiseres gjenopprettingen, og ikke minst hvem verifiserer?
- Hvordan håndteres gjenopprettinger som ikke ble 100% fullført?
- Hvordan håndteres gjenoppretting av kun en del av systemet?
- Hvordan installeres systemet fra bunnen av?2
Applikasjons-metadata
I tillegg til ren driftsdokumentasjon kan det også være nyttig å vite noe om miljøet rundt applikasjonene.
- Oppdateringsansvarlige
- Systemeier
- Leverandør
- Avtaler
- Lisensinformasjon
Fotnoter:
- Et godt eksempel er en tabbe vi har gjort, som vi nå holder på å rette opp. Vi brukte «Public Folders» i Exchange til en del ressurser. Problemet er at det kun er mulig å ta backup av hele Public Folders, ikke bare en mappe. Det er med andre ord ikke mulig å kjøre gjenoppretting av kun en mappe, og langt mindre enkelte eposter/kalenderelementer. Da blir backup nesten meningsløst.
- Det er kanskje ikke alt som er hensiktsmessig å kjøre backup av. Da er det greit å vite hvordan man installerer det på nytt fra bunnen av, og det bør ikke undervurderes som gjenopprettingsløsning. Mange bruker det allerede på klienter.
