Skriver du användardokumentation? Manualer eller hjälptexter till programvara, eller kanske en instruktion till en maskin? Här får du tips som hjälper dig på vägen.
Vem ska läsa texten och varför?
Börja med att ta reda på vem som ska läsa texten och varför. Vad har användarna för behov? Vad ska de använda systemet, programmet eller maskinen till? Först när du vet det kan du hjälpa användarna genom att svara på deras frågor och leda dem genom sin process. Om du inte vet vad användarna ska göra finns risken att du i stället börjar beskriva allt som systemet kan göra. Det blir ett inifrånperspektiv som inte hjälper användaren.
Ta med rätt information
All text som är med i handboken eller hjälptexten ska svara på de frågor som användarna har om systemet eller maskinen. Det kan betyda att du inte ska ha med bakgrundsinformation om varför handboken kom till eller vad som har uppdaterats sedan förra versionen. Tänk på att användarna har ett problem. Lös det. Om bakgrundsinformationen behövs så kan den få ett eget dokument som den som är intresserad av kan läsa.
Skilj mellan beskrivning och instruktion
Användardokumentation innehåller två typer av grundläggande text:
1. beskrivande text
2. steg för steg-instruktioner.
Skilj de här två texttyperna åt, så blir det lättare för användarna att följa med i texten. Men hoppa inte över någon av dem. Båda texttyperna fyller en viktig funktion. Den beskrivande texten hjälper användarna att förstå sammanhanget, medan instruktionen talar om hur de ska göra. Här följer ett exempel på ett avsnitt i en handbok. Texten innehåller först beskrivande text och sedan en steg för steg-instruktion:
Synkronisera handdatorn
Synkronisera handdatorn varje gång du har rapporterat ett arbete, dock minst
tre gånger per dag. Att synkronisera innebär att om det finns nya arbetsorder
till dig så får du dem till din handdator. Samtidigt skickas de arbetsorder
som du är färdig med tillbaka till huvudkontoret.Så här startar du en synkronisering:
1. Gå till huvudmenyn.
2. Klicka på knappen Synkronisera.
Använd numrerade listor
För steg för steg-instruktioner kan du använda numrerade listor, som i exemplet ovan. Numreringen gör att du inte behöver använda uttryck som för det första, först, därefter eller sedan i instruktionerna.
Upprepa information
Du kan inte räkna med att användarna läser ett långt dokument, som en manual, från början till slut. Samma sak gäller om du skriver hjälptexter till programvara eller webb. Användarna slår upp det som de behöver ha hjälp med och läser just det avsnittet och inget annat. Var därför inte rädd för att upprepa samma eller liknande information i flera olika avsnitt i texten.
Fler tips
Några fler tips för dig som skriver användardokumentation:
- Använd du-tilltal.
- Använd uppmaningar (”Klicka på Sök.”)
- Skriv tydliga, konkreta rubriker som talar om för användarna vad de får hjälp med i just det avsnittet.
- Använd gärna bilder för att förtydliga.
- Skriv rakt på sak och börja med det viktigaste, ofta det som användarna ska göra.
- Testa texten efter att du har skrivit den. Du behöver gå igenom texten själv och se att den stämmer överens med systemet eller maskinen. Du behöver också låta en verklig användare, eller gärna flera, testa användardokumentationen och se att den går att använda.
Vill du veta mer?
Läs gärna mitt tidigare språkbrev Skriv instruktioner.
Behöver du hjälp att skriva användardokumentation?
Jag skriver pedagogisk och användbar användardokumentation på svenska. Kanske behöver du hjälptexter eller en användarmanual? Varmt välkommen att kontakta mig för att få ett kostnadsförslag.
