Skriva användarmanualer

Innehåll

• Vet vem du talar till
• En bra start är din innehållsförteckning
• Samla all nödvändig information
• Det faktiska skrivandet (illustrerandet?) av er manual
• Välja lämpligt format

Vet vem du talar till

Om du vet vilken målgrupp du har, vet du två väldigt viktiga saker som är nödvändiga för att skriva en användarmanual av hög kvalitet.

Först och främst vet du något om din ton. Om du skriver an användarmanual för förstagångsanvändare av ett larmsystem, kan du behöva förklara hur man ska ställa in sensorerna i ett rum. Du ska motivera dem till att titta på flera exempel så att användarna kan använda sensorerna effektivt. Detta kräver att man formar ett motiverande förhållande med läsaren så att han/hon får ut det mesta från er produkt.

Om er produkt däremot inte behöver en introduktion och eftersom användare kommer att vara bekanta med den direkt från start kan du utelämna exempel eller råd om att experimentera. Ditt språk kan vara mer affärsmässigt, och bara peka ut var de relevanta knapparna finns.

Det andra övervägandet ligger ganska väl i linje den första punkten. Alla målgrupper värderar sin egen nivå av detaljer. Det är inte nödvändigt att för underhållspersonal förklara hur man rengör en tillverkningsmaskin. Personer i denna grupp skulle bli förnärmade om du skulle skriva vad de ska göra. Däremot är det nödvändigt att för personal på ett litet företag beskriva hur man byter skrivarpatroner. Eller informera dem om när en skrivare behöver rengöras inuti.

Det är alltid viktigt att tänka på vem du skriver för.

En bra start är din innehållsförteckning

Varför är innehållsförteckningen en bra början? Eftersom en innehållsförteckning tvingar skribenten av en användarmanual att tänka på vad han/hon vill säga och i vilken ordning. Självklart kommer det att finnas ett förord eller en introduktion i alla användarmanualer. Utan tvekan kommer det även att finnas säkerhetsinstruktioner i början av manualen. I slutet bör man också beskriva underhållsfrågor. Vad ska man då skriva mellan dessa kapitel?

Det beror på produkten. För en del produkter är inställningar viktiga: en dag kan en pump fungera ’normalt’, en annan dag är det bäst att ställa in den på motsatt håll. Detta kan till exempel bero på vattennivåer. Ett kapitel som kallas ”Vardagliga inställningar” kan vara lämpligt här. Ett annat kapitel kan handla om att samla information om hur mycket vatten som transporterats och exakt vart. Ett sådant kapitel kan kallas ”Övervakning av resultat”.

Ta ett annat exempel: en så kallad ’multifunktionsenhet’. För en ’multifunktionsenhet’ kan kapitel i innehållsförteckningen baseras på dess olika funktioner: utskrift, kopiering, scanning, fax och så vidare.

Så länge det finns någon logisk ordning som användaren kan relatera till kan användarmanualen skummas igenom effektivt. I det här avseendet är det absolut nödvändigt att varje kapitel och varje stycke har en entydig rubrik: ”Skriva ut med datorn”, ”Kopiera utan dator”, ”Scanna till din dator” och så vidare.

Samla all nödvändig information

En teknisk skribent har ett rykte om att vara introspektiv, intresserad som han/hon är bara av en sak: teknologi.

Detta rykte gör honom inte rättvisa. En teknisk skribent bör veta mycket om spänning, ström, resistans och megahertz. Han bör även veta hur man samlar in all nödvändig information. Ganska mycket information kan finnas tillgängligt på papper eller digitalt. Man kan tänka sig en riskanalys, 3D, CAD-illustrationer, specifikationer och så vidare.

Det är även ganska möjligt, även troligt, att denna information inte alltid svarar på alla frågor en teknisk skribent har. Trots allt vill den tekniske skribenten föreställa sig som användaren. Om dokumentationen inte beskriver behovet av att ställa pumpen i motsatt läge i detalj, behöver han fråga experterna: varför behöver man ställa in denna specifika pump i motsatt läge?

Detta betyder att den tekniske skribenten måste ha kommunikationsförmåga. Han måste även ha social kompetens. Att placera sig i någon annans skor handlar om att vilja lära känna den personen.

Att porträttera en teknisk skribent som ”endast en tekniker” vore ett misstag. Det kräver mer än att vara tekniskt kunnig för att skriva en användarmanual.

Det faktiska skrivandet (illustrerandet?) av er manual

Ok, du har samlat in all nödvändig information. Nu är det dags att faktiskt skriva er användarmanual. Tre överväganden kommer i åtanke.

Det första övervägandet handlar om minimalism. Minimalism är en filosofi om att inte använda fler ord om ett ämne eller en uppgift än vad som behövs. Det är inte nödvändigt att berätta för läsaren att en ventil finns tillgänglig i tre färger när den enda ventilen på en tank är röd. En användare behöver bara veta hur man använder ventilen och när. Detta kanske verkar självklart, men kan visa sig vara en riktig utmaning i (alltför) många fall. En del företag kastar inte bort sin ’marknadsföringschef’ lättvindigt.

Det andra övervägandet är: använd alltid förenklad teknisk engelska om du vill vara affärsmässig. Förenklad teknisk engelska, eller STE, förkastar ord som är tvetydiga, som ’carry out’. ’To carry out’ kan betyda ’ta bort något från en viss plats’, men också ’vidta åtgärder’. I STE duger endast verbet ’to do’. Dessutom begränsar STE antalet ord i en mening till ungefär 20. Detta gör alla meningar enkla att förstå.

Det tredje övervägandet är också väldigt viktigt. Varför använda text om en illustration fungerar lika bra om inte bättre? Trots allt, eliminerar en illustration behovet av att översätta text. Ännu viktigare är dock det faktum att personer först och främst är visuellt orienterade. Uttrycket ’en bild säger mer än 1000 ord’ antyder att människor förstår budskapet snabbare och bättre när det är illustrerat. Du kan inte presentera all information visuellt (”Säkerställ att hålen år fria från träflis och sågspån”). Men där kan fördelarna för användaren vara enorma. På så sätt får ’skriva en användarmanual’ en helt ny mening.

Välja lämpligt format

Det finns ett val kvar: vilken typ av layout vill du ha? Eller i fackspråk: vilken mall vill du definiera så att er användarmanual inte bara matchar användarens önskan utan även er företagsidentitet? Konsekvens är nyckeln: varje kapitel och varje stycke ska se ut på samma sätt.

Det finns moderna mjukvaruverktyg som hjälper er att definiera en professionell mall. Dessutom finns det innehållshanteringssystem på marknaden som kan omvandla en källtext till vilket format som helst, vare sig formatet är ett A5 häfte, en A4 bok, en PDF-fil (porträtt eller landskap) eller en hemsida som anpassar sig automatiskt om den visas på en dator, tablett eller smartphone.

Företag som specialiserar sig på att skriva användarmanualer vet hur de kan hjälpa er att välja relevant format – om ni skulle behöva råd.