Skriva tekniska manualer

Tio överväganden

Hur ska man skriva en teknisk manual? Tekniskt skrivande för alltid med sig tio överväganden som alla tekniska skribenter ska vara medvetna om.

• 1. Vet vem du talar till
• 2. Var medveten om alla direktiv
• 3. Följ riktlinjerna
• 4. Samla så mycket information som möjligt
• 5. Skriv effektivt
• 6. Använd bilder!
• 7. Använd animationer
• 8. Översätt och … lokalisera
• 9. Bygg upp ett arkiv
• 10. Publicera i vilken (ytterligare) form som helst

1. Vet vem du talar till

Expertis om manualskrivande handlar först och främst om att veta vem du talar till. Tonläget för äldre som använder en tablett måste vara ganska olik den till en mekaniker som känner sin kemiska fabrik utan och innan.

2. Var medveten om alla direktiv

När en produkt är felaktig på något sätt, kan tillverkaren eller återförsäljaren hållas ansvarig för konsekvenserna. ’Felaktig på något sätt’ är verkligen rätt uttryck, eftersom de europeiska direktiven även inkluderar krav för att skriva tekniska manualer (eller vilken manual som helst för den delen). Detta betyder att er tekniska manual är föremål för granskning. En manual är en integrerad del av produkten och kan leda till juridiskt ansvar!

3. Följ riktlinjerna

Lagenliga krav eller direktiv är väl bra. Men hur vet man att man följer dessa krav? Som tur är finns det riktlinjer. Dessa riktlinjer kan ha ett nationellt ursprung. Dock skiljer det inte mycket mellan, låt oss säga, Tyskland och Nederländerna. Självklart ska man vara medveten om dessa riktlinjer. De talar om för dig vilka kapitel som ska ingå, vilken storlek bokstäverna bör ha och så vidare.

4. Samla så mycket information som möjligt

Det är bättre att välja ur för mycket information än riskera att chansa att er tekniska manual (eller inte så tekniska manual) är inkomplett. CAD-illustrationer? Marknadsföringsdokumentation? Allt tillför kontext och bör vara en integrerad del av manualskrivande.

5. Skriv effektivt

Hur ska man skriva en teknisk manual effektivt? Genom att använda expertis för manualskrivande som du har till förfogande. Det finns åtminstone tre principer som leder till effektivt manualskrivande. Förenklad teknisk engelska (STE), minimalism och ämnesbaserat författande.

Förenklad teknisk engelska

engelska är en specifik standars som förenklar användningen av det engelska språket i tekniska dokument genom att sätta en gräns för antalet ord i en mening. Dessutom är uppsättningen ord begränsat (’to do’ är enklare att förstå än ’to carry out’).

Minimalism

Minimalism är ett sätt att tänka. Detta sätt att tänka är: ange endast information som är verkligt användbar. Ett exempel från flygindustrin kommer i åtanke. När ett flygplan fick en tryckförlust, började nödmanualen – i själva verket en checklista – med att tala om att något kunde vara del med en ventil. Detta är ett typexempel på en felaktig start. Den första meningen borde ha varit: ”Ta på dig syrgasmasken.” Minimalism kunde ha räddat liv här, eftersom piloterna inte kände sig benägna att ta på sig sina syrgasmasker. Och checklistan talade inte om det för dem. Minimalism berättar för oss att vi ska fokusera på våra uppgifter, inte på information som kan ges i ett senare skede (eller behövs inte alls).

Ämnesbaserat författande

Ämnesbaserat författande betyder att skriva (tekniska) manualer handlar om att skriva byggstenar som kan återanvändas i andra och nyare tekniska manualer. Till exempel kan kapitlen ’Säkerhetsåtgärder’ och/eller ’Underhåll’ vara identiska i andra manualer. Genom att skriva ämnesbaserat, istället för linjärt, blir informationsblock enkelt tillgängliga hela tiden.

Användningen av dessa tre principer kommer att förkorta utbildningstiden för mekaniker med så mycket som 30 %. Användare kan ta in 25 % mer information som en följd av att föra samman de tre principerna för skrivande.

6. Använd bilder

Att skriva tekniska manualer ska inte omfatta … manuellt skrivande. Ännu bättre: att skriva tekniska manualer ska helst inte omfatta att skriva manualer. Om en bild berättar mer än 1000 ord, ska illustrationen ha företräde, En illustration kan vara mycket effektivare om du vill få ut ditt budskap. Det kan också vara med kostnadseffektivt att producera bilder, I vilket fall som hels, det behövs ingen översättning för en bild.

7. Använd animationer

När en användare ska genomföra många liknande handlingar (håll på toppen av flaskan medan resten av flaskan ska föras mot vänster, sedan ställa flaskan upp och ner och så vidare) kan en serie med illustrationer vara effektivt. Men en animation kanske är det extra alternativet ni letar efter.

8. Översätt och … lokalisera

Det kan vara så att din manual behöver översättas, om endast på grund av europeiska direktiv. Det säger sig självt att texter på det lokala språket också är väldigt användarvänliga: nästan alla tycker om att bli tilltalade på sitt modersmål.

En översättning ska innebära mer än att byta ut ord, Den ska även innehålla ’lokalisering’. Vad betyder egentligen ’lokalisering’? Det betyder att för användare på den europeiska kontinenten ska ratten i en bil sitta på vänster sida, medan den för användare i Storbritannien ska sitta till höger. För att ge dig ett exempel.

9. Bygg upp ett arkiv

Det är viktigt att använda innehållshanteringssystem med vilket du kan bygga ditt eget arkiv. På detta sätt kan du enkelt använda och återanvända existerande informationsblock.

10. Publicera i vilken (ytterligare) form som helst

Varför är det så viktigt med innehållshanteringssystem? Eftersom du kan återanvända existerande informationsblock i varje tänkbar kanal: tryck, online eller off-line på en enhet (genom PDF-filer till exempel). En närvaro online eller off-line gör det möjligt att använda 3D-animationer.