Blir dina instruktioner långa och komplicerade? Det är lätt hänt, eftersom det ofta finns så mycket att förklara för användaren, annars hade du ju inte behövt skriva instruktionen från första början.
Men för att instruktionen ska bli lätt att följa är det viktigt att du håller den ren från allt som inte beskriver hur något ska göras. Och lugn, den informationen ska också med, men inte i själva instruktionen. Häng så ska jag visa hur du kan tvätta fram en ren instruktion.
Vad räknas som instruktion?
Låt oss börja från början. Vad är en instruktion? Jo, en instruktion är det som beskriver vad och hur en användare ska göra för att uppnå ett visst mål. Som exempel kan en instruktion för att brygga kaffe se ut så här:
Instruktionen ska alltid:
- vara i stegform med numrerade steg
- ha en handlingsuppmaning per steg och
- inleda varje steg med ett verb.
Vad innebär REN instruktion?
Så vad menar jag då med ren instruktion? Jo, ganska ofta vill skribenten blanda in en massa annan information längs vägen, för att det känns som att det hör dit. Då skulle samma instruktion för att brygga kaffe se ut så här:
Som du ser sväller instruktionen betänkligt om du inte är hård med att hålla instruktionen ren.
Men det betyder inte att den insprängda informationen i instruktionen ovan är onödig. Nejdå. Den ska också med i manualen, men vi lyfter ut den från instruktionen och låter den stå för sig. Det för med sig två bra saker:
- Instruktionen blir kortare och tydligare.
- Faktan blir lättare att hitta när den står för sig och har en egen rubrik.
Så var hård! Skriv minimalt i själva instruktionen, bara det som absolut behövs för att användaren på ett säkert och effektivt sätt ska kunna genomföra uppgiften.
Resten – all tilläggsinformation – lyfter du ur och lägger i ett eget block.
Det rena resultatet: tydlig information
När du har lyft ur tilläggsinformationen till egna block kommer du förmodligen att ha kanske 3-7 små block med information i avsnittet om att brygga kaffe.
Då kan det se ut så här:
Informationen är nu mer modulär, vilket blir lätt för användaren att hitta i, och även lätt att hålla uppdaterad för dig som skribent. Det är själva grunden i agil dokumentation.
Sammanfattande tips för en ren instruktion
För att komma igång med din nya manual, eller för att putsa på din befintliga, så rekommenderar jag att du gör följande:
- Titta på din befintliga manual (om du har en) och leta upp vad som är instruktioner.
- Skriv dina rena instruktioner. Skriv så lite som möjligt!
- Notera vilken ytterligare information du var frestad att ta med i instruktionen och skriv det i ett eget block med tydlig rubrik innan instruktionen.
Se hur allt bara faller på plats.
