Jag älskar hacks av olika slag – knep och trick som förvandlar något svårt till något enkelt. Det kan handla om allt från att gnida paraffin på tröga byrålådor eller lära sig minnestekniker, till att använda snabbkommandon i utforskaren.

Är metoder fusk?

Självklart ska du inte fuska dig igenom livet, vissa saker är komplicerade och kräver mycket ansträngning för att bli bra. Men precis som du kan lära dig systematiska metoder för att lösa Rubiks kub, så finns det principer som ”alltid funkar” när det kommer till att skriva manual.

Jag har själv spenderat många timmar på att vrida på den där färgglada kuben, till ingen större nytta eller glädje. Jag lyckades på sin höjd lösa en sida, sedan tog det stopp.

Jag har också spenderat många ineffektiva timmar på att skriva manualer – innan jag visste att det fanns lättare sätt.

Jag kände inte till knepen

När jag först började jobba som teknisk skribent kunde jag inget särskilt om teknisk dokumentation. Jag visste inte ens att det fanns saker jag borde veta om teknisk dokumentation. Jag visste inte att det var en profession, med särskilda metoder och koncept.

Däremot skrev jag gärna och hyfsat korrekt, jag var mån om att det skulle bli bra för läsaren. Jag ville också hitta en bra struktur för de väldiga mängderna Worddokument som jag övertog och skulle jobba vidare på. Men utan de grundläggande kunskaperna famlade jag. Resultatet blev ärligt talat inte så särskilt bra.

Första aha-upplevelsen

När jag till slut insåg att andra rimligen måste ha brottats med samma problematik före mig så började jag googla. Och läsa på.

En av de första polletterna som trillade ner var den om att skilja mellan instruktioner och fakta. Vissa metoder förespråkade ytterligare uppdelningar. Men utan någon att bolla med hade jag svårt att själv bena ut var jag skulle placera in mitt eget material i den strukturen. Det fick räcka med att skilja på instruktioner och fakta, till att börja med.

Lärorika år

Jag fick senare lära mig yrket på riktigt av rutinerade och erfarna tekniska skribenter. De gav mig inblick i både metoder och verktyg.

Jag fick lära mig göra bilder med rätt perspektiv, layoutprinciper som funkar för manualer och hur fel översättningarna blir om inte grundmaterialet är bra. Jag fick lära mig versionshantering, hur man bygger upp index och svårigheten i att låta 200 manualer delvis dela samma innehåll, men också finessen med det.

Fler hacks för manualer

Jag känner fortfarande att det är den där första aha-upplevelsen som sitter djupast. Att skilja på instruktioner och fakta. Det innebär att skilja på vad användaren behöver göra och vad användaren behöver veta för att göra det.
Med den insikten föll en massa sakar på plats, det blev mera ordning och reda i skrivprocessen och det blev så mycket lättare att skriva. Den blev mitt första manual-hack!

Därför finns den principen med som en av grundprinciperna för att skriva manual i min webbkurs Skriv en manual och få återkoppling.

En annan av grundprinciperna finns som gratislektion i webbkursen. Du kan klicka här för att titta på gratislektionen.