Så skriver du bättre instruktioner

Tvättråd instruktioner

Instruktioner finns överallt. Alla är tyvärr inte bra. Vissa är rent av omöjliga att följa. Det är onödigt, eftersom det finns gott om knep att ta till för att skriva bättre instruktioner.

Dagens exempel hittade jag i min egen tvättstuga.

Vad menar de egentligen?

Min skaljacka hade blivit bedrövligt smutsig efter höstens leriga trädgårdsarbete. Den var i akut behov av tvätt och i skåpet hittade jag specialtvättmedel för goretex-material. Jag vände på flaskan för att läsa instruktionerna

Bild på instruktioner för maskintvätt

Förvirrad direkt

Redan på första steget kände jag mig lite osäker.

1. Avlägsna eventuella tvättmedelsrester från behållaren.

Vilken behållare? Menar de trumman i tvättmaskinen? Eller tvättmedelsfacket? Eller i en sådan där tvättmedelsboll som vi brukar lägga direkt i maskinen?

I andra steget gjorde jag först ett litet snedtänk som förmodligen är en arbetsskada.

2. Lägg in max 2 produkter i maskinen.

Ordet Produkter tolkade jag som den produkt jag höll i, alltså tvättmedlet. 

Sedan förstod jag ju att det handlade om antal plagg i maskinen. Kanske kunde det handla om väskor eller skor också och därför valde de den mer generella termen produkt, vilket alltså först förvirrade mig lite.

Att generiska termer kan göra texten svårläst kan du läsa mer om i det här blogginlägget om konkret och abstrakt text.

Många rätt i tvättrådet

Andra saker i den här instruktionen är i alla fall helt enligt boken (eller enligt kursen, haha), som exempelvis:

  • instruktionen skrivs med en numrerad lista
  • handlingsuppmaningen inleds med ett verb
  • varje steg innehåller endast en handlingsuppmaning.

Men varför säger hon inget om siffrorna?

Jag visste väl att du skulle reagera på att det stod ”max 2 produkter” i tvättrådet! Du har rätt, de vanliga riktlinjerna för att benämna tal i text är följande princip:

  • små tal upp till tolv skriver du med bokstäver (två, fem och tio)
  • större tal skriver du med med siffor (13, 25 och 158).

Gränsen är dock inte exakt. Vissa hävdar att det är bra att skriva tal upp till tjugo med bokstäver. (Ser du, det gick bra!)

För och emot siffror i text

Det här med huruvida bokstäver eller siffror är det bästa är något som jag har sett debatteras lite inom teknikinformationskretsar. Borde vi kanske skriva siffror även för tal upp till 12, som in tvättinstruktionen? Jag kan se två sidor av saken.

Fördelar med siffror

Det kan vara en bra idé att skriva tal upp till 12 med siffror eftersom:

  • Siffror är tydligare än bokstäver.
  • Det blir enklare om du vill använda variabler.
  • Siffror är ganska vanligt i texter på webben, framför allt rubriker, eftersom en siffra är mer iögonfallande än ett ord i text.

Fördelar med bokstäver

Det kan vara en bra idé att skriva tal upp till tolv med bokstäver eftersom:

  • Läsaren stör sig på att användningen av siffror bryter mot gällande riktlinjer.
  • En siffra bryter av mot textflödet och kan därför störa och stoppa upp läsningen.
  • Ögat dras till siffror och har du då siffror på flera ställen kan ögat börja hoppa mellan siffrorna istället för att följa texten.

Min omskrivning av tvättråden

Tillbaka till att skriva bättre instruktioner, det där med siffrorna var ju bara en parentes. 

Om jag fick skriva om instruktionen skulle jag nog landa i följande formulering (givet att jag har tolkat instruktionens första steg rätt):

Maskintvätt:

1. Rengör tvättmaskinens fack för tvättmedel så att det inte innehåller rester av tvättmedel.

2. Lägg in max två plagg i maskinen.

3. Använd två kapsyler (100 ml) tvättmedel i mjukt vatten och tre kapsyler (150 ml) i hårt vatten.

4. Följ plaggets tvättråd.

 

PS.

Om du vill lära dig fler knep för att skriva bättre instruktioner så rekommenderar jag min webbkurs Skriv en manual. Där får du också lära dig:

  • en metod för hur du avgör vad som ska med i manualen eller inte
  • hur kan presentera olika sorters fakta så att det blir lätt att läsa
  • principer för hur du bygger upp och strukturerar manualen
  • vad du bör tänka på när det gäller layout, läsbarhet och funktion.

Om du vill kan du kika på en gratislektion för att se om det verkar vara ett upplägg som passar dig. 

Dela på facebook
Dela på twitter
Dela på linkedin
Dela på email

Jag hjälper dig med metoder, kunskap och erfarenheter kring produktdokumentation så att den blir både effektiv och användbar.

Fler inlägg

Musfälla

Trick för att locka information ur utvecklare

Att få fram underlag till teknisk dokumentation är verkligen en utmaning. Själv har jag provat allt. Jag har mutat utvecklare med kakor. Intervjuat stressade projektledare. Filtrerat ofantliga mängder med utvecklingsärenden

Tips till dig som skriver lathund i affekt

Behöver dina kunder en lathund för er produkt? Eller behöver ni själva en intern lathund på kontoret för att komma tillrätta med reseräkningarna? Lathundar kan vara många olika saker. Allt

Är din dokumentation agil?

Ni har en agil utvecklingsprocess. Check. Ni har kanske till och med skickat ledningen på kurs och har nu en agil organisation i stort. Toppen! Men hur står det till

Vad kostar en manual

Vad kostar en manual?

Tid är pengar. Den största kostnaden för teknisk dokumentation är ofta tiden som skribenten lägger ner. Visst kan olika slags verktyg kosta pengar. Om du dessutom skickar manualen på tryck

Illustrerad instruktion

6 olika sätt att skriva instruktioner

Det finns många olika sätt att skriva instruktioner. Ett format är inte nödvändigtvis bättre än ett annat. Flera faktorer styr vilken typ av instruktion som fungerar bäst:  personliga preferenser: vissa

Gunilla Svanfeldt Omslag

Samtycke till marknadsföring

Vi lagrar informationen som du anger i formuläret för att kunna kontakta dig med nyhetsbrev, om uppdateringar och med erbjudanden. 

Markera kryssrutan i formuläret för att ge ditt samtycke till att vi skickar e-post till dig.

We use MailerLite as our marketing automation platform. By clicking below to submit this form, you acknowledge that the information you provide will be transferred to MailerLite for processing in accordance with their Privacy Policy and Terms of Service.