Fagstoff

Skrive brukerdokumentasjon

Publisert: 12.12.2012, Oppdatert: 04.03.2017
  • Innbygg
  • Enkel visning
  • Lytt til tekst
  • Skriv ut
Kvinne med pc

De aller fleste som jobber med IKT, vil på et eller annet tidspunkt få behov for å skrive informasjon eller dokumentasjon som skal leses og forstås av brukere.

Det kan være en utfordring – det er ofte vanskeligere enn man tror – å skrive god brukerdokumentasjon. Sjansen for et godt resultat øker imidlertid betraktelig hvis du stiller deg selv noen enkle spørsmål før du begynner å skrive:

 

  • Hvem skriver jeg for? 
  • Hvilket kunnskapsnivå har brukeren?
  • Hvorfor leser brukeren dokumentasjonen?
  • Når og hvor leser brukeren dokumentasjonen?
  • Hva vil jeg oppnå med dokumentasjonen?
  • Hvilket detaljnivå er nødvendig?
  • Kan illustrasjoner eller video være til noen hjelp?

Ved å besvare disse spørsmålene blir du bevisst på hvem du skriver for, og hva dokumentasjonen må inneholde for at den skal bli forståelig og nyttig for den som skal lese. I tillegg unngår du å ta med informasjon som er unødvendig, eller som kanskje ikke blir forstått eller lest i det hele tatt.

I noen tilfeller vil brukeren også være usikker på om den informasjonen han har funnet frem til, er den riktige, om den er ment for ham, og om han behøver og lese den. God brukerdokumentasjon tar hensyn til dette og opplyser med en gang leseren hvem den er beregnet for, og hva han kan forvente å finne informasjon om. (Se eksempel i figuren under.)

Eksempel på innledning til brukerdokumentasjon. Eksempel på innledning til brukerdokumentasjon.
Opphavsmann: Arne Jansen

Ved å spesifisere hvem dokumentet er beregnet for, noen stikkord om hva det inneholder, og hvorfor du har skrevet det, får brukeren med en gang mulighet til å avgjøre om dette er noe han bør lese. Videre bør dokumentet ha en innholdsfortegnelse som gjør at det er enkelt å finne frem.

Legg merke til at det å kunne besvare de spørsmålene vi listet opp innledningsvis, er utgangspunktet både for innledningen til dokumentasjonen og hvilket innhold som skal være med. 

God brukerdokumentasjon opplyser med en gang leseren hvem den er beregnet for, og hva han kan forvente å finne informasjon om.