Fagstoff

Skrivetips

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

Ikke alle er forfattere – og det er heller ikke nødvendig for å skrive brukerdokumentasjon. Det vesentlige er at informasjonen er lettlest, og at den blir forstått.

Skrivefeil kan være morsomme og sjarmerende i visse sammenhenger, men i brukerdokumentasjon bør du passe på å unngå stavefeil.Skrivefeil kan være morsomme og sjarmerende i visse sammenhenger, men i brukerdokumentasjon bør du passe på å unngå stavefeil.
Fotograf: Berit Keilen
  

 

Det vesentlige er at informasjonen er lettlest, og at den blir forstått. 

 


Her ser du et eksempel på hvordan skjermdumper og tekst kan spille sammen og forenkle forståelsen for leseren.

 

 

Her kan du finne et eksempel på en enkel brukerveiledning i videoformat: Skifte blekk i printeren 

Bruk enkelt språk og korte setninger

Korte setninger er lettere å lese og lettere å forstå. Unngå også å bruke mange lange og vanskelige ord. Det er ikke alle som leser like godt.

Faguttrykk kan by på spesielle problemer fordi du ikke kan være sikker på at brukeren forstår dem. Generelt bør du forsøke å unngå faguttrykk, men i noen tilfeller er det uunngåelig. Er du usikker på om brukeren kommer til å forstå et uttrykk, bør du forklare det den første gangen du bruker det.

Det som er opplagt for deg, er ikke alltid like opplagt for andre

Vær bevisst på hvem du skriver for, og hvilket kunnskapsnivå brukeren har. Du kjenner ditt eget fagfelt godt, og det er derfor fort gjort å forenkle stoffet slik at det blir uforståelig for brukeren. Samtidig må du selvsagt ikke undervurdere brukerens kunnskapsnivå og plage ham med for mange unødvendige detaljer heller.

Vær konsekvent

Ofte finnes det flere uttrykk og skrivemåter som i praksis betyr det samme, men dette kan virke forvirrende på brukeren. Hvis du har begynt å skrive for eksempel skriver, bør du være konsekvent og ikke skrive printer senere.

Bruk stavekontrollen

Det burde være unødvendig å si det, men stavefeil er unødvendig og får dokumentasjonen til å virke uprofesjonell. Hvis du ikke stoler på stavekontrollen, kan du la noen andre lese gjennom og rette eventuelle skrivefeil for deg.

Hvis det er vanskelig å forklare, vis det i stedet

Bilder av programvinduer sammen med tekst gjør det enklere for brukeren å se hvor han skal klikke, og hvordan skjermen hans skal se ut underveis. En annen mulighet er å bruke et verktøy for å spille inn det som skjer på skjermen mens du utfører en oppgave, og deretter lagre det som en video.

Bruk av bilder og video gjør at du kan skrive mindre, og du kan bruke bilder til annen dokumentasjon også. Det er for eksempel enklere å ta noen bilder eller lage en video av hvordan man skal skifte blekkpatron i en skriver, enn å forklare hele prosessen med ord. Dette kan du se mange eksempler av på YouTube, der både produsenter og brukere har lagt ut videoer med brukerveiledninger, tips og demonstrasjoner.