Skrive brukardokumentasjon

Sjansen for eit godt resultat aukar likevel monaleg viss du stiller deg sjølv nokre enkle spørsmål før du tek til å skrive:

• Kven skriv eg for?
• Kva kunnskapsnivå har brukaren?
• Kvifor les brukaren dokumentasjonen?
• Når og kvar les brukaren dokumentasjonen?
• Kva vil eg oppnå med dokumentasjonen?
• Kva detaljnivå er nødvendig?
• Kan illustrasjonar eller video vere til hjelp?

Ved å svare på desse spørsmåla blir du medviten om kven du skriv for, og kva dokumentasjonen må innehalde for at han skal vere forståeleg og nyttig for dei som skal lese han. I tillegg unngår du å ta med informasjon som er unødvendig, eller som kanskje ikkje blir forstått eller lesen i det heile.

I nokon tilfelle vil brukaren òg vere usikker på om den informasjonen han har funne fram til, er den riktige, om det er meint for han, og om han treng å lese det. God brukardokumentasjon tek omsyn til dette og opplyser med ein gong lesaren kven han er meint for, og kva lesaren kan vente å finne informasjon om.

Ved å spesifisere kven dokumentet er meint til, nokre stikkord om kva det inneheld, og kvifor du har skrive det, får brukaren med ein gong moglegheit til å avgjere om dette er noko han bør lese. Vidare bør dokumentet ha ei innhaldsliste som gjer at det er enkelt å finne fram.

Legg merke til at det å kunne svare på dei spørsmåla vi lista opp innleiingsvis, er utgangspunktet både for innleiinga til dokumentasjonen og det innhaldet som skal vere med.