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 eller på översättning är det så klart inte heller gratis. Men för de allra flesta är det ändå arbetstiden som är den största posten.
Så istället för Vad kostar en manual? så kan vi fråga Hur lång tid tar det att skriva en manual?
Det här påminner mycket om en vanlig motfråga:
Hur långt är ett snöre?
Det är helt enkelt väldigt svårt att säga hur lång tid det tar att skriva en manual. Tidsåtgången beror på många olika faktorer, bland annat:
- Hur omfattande och komplicerad är produkten?
- Hur lätt är det för mig som skribent att få information om produkten?
- Finns det specifikationer eller annan dokumentation att utgå ifrån?
- Kan jag testa produkten medan jag skriver?
- Ska manualen rikta sig till en specifik typ av användare eller till flera?
Schablon för att estimera tid
Jag har fått lära mig några schablonmässiga riktlinjer när det gäller att komma fram till hur långt snöret kommer att bli. En viss schablon gäller när du skriver en ny manual, en annan när det gäller uppdatering av en befintlig.
Estimerad tid för ny manual
För en nyproducerad manual kan du räkna 3-4 timmar per sida, enligt schablonen. Det kan tyckas mycket, men här ingår alltså all bakgrundsresearch, skriva och illustrera innehållet, strukturera, kommunikation med ibland ovilliga experter, granskningar, rättningar och slutlig publicering.
En liten detalj som ställer till det för att kunna använda schablonen, är att du från början inte vet hur lång manualen kommer att bli. Men du kanske har en idé om huruvida manualen ska bli en liten lathund på 20 sidor (60-80 timmar), en mer normal manual på 200 sidor (600-800 timmar) eller ett uppslagsverk på 700 sidor (2100-2800 timmar).
Hur kan du minska tidsåtgången?
Siffrorna här ovan låter ju fruktansvärt mycket, även i mina öron. Så du förstår att ju mer information det går att skaka fram i förväg, desto snabbare kommer det gå att skriva. Och det handlar inte bara om funktioner i produkten.
Det handlar också om grafisk profil, användarscenarier och om vilken regulatorisk information som behöver stå med. Vad ska stå på baksidan? Hur är det med kontaktinformation? Vad ska användaren göra om systemet havererar? Kanske finns det listor över alla ikoner som kan visas, över vilka olika statusar som en process kan ha?
Ju mer jag som skribent kan få veta utan att testa mig fram till olika kombinationer, desto mer tid sparar vi.
Kom på banan snabbt
Om det inte finns tidigare dokumentation att utgå ifrån så är det snabbaste sättet att få igång skribenten dels en demo av hur användaren ska jobba i produkten, dels att skribenten är med på alla scrum-möten och överhör de diskussioner som ni för.
Kör ni inte scrum så kanske ni har andra frekventa avstämningar? Låt skribenten vara med och lyssna! Den tid som går åt på att sitta med på planeringar, dagliga stand-ups och demos, är en prutt i världsrymden jämfört med att i efterhand jaga den informationen.
Estimerad tid för att uppdatera en manual
För att uppdatera en befintlig manual kan du räkna 1 timme per sida, enligt schablonen. En fördel här är ju att det redan finns ett sidantal att utgå ifrån. Å andra sidan kan en uppdatering handla om att uppdatera lite bilder och ändra några termer, eller så kan det handla om en total ombearbetning.
Du kan ju helt behöva skriva om manualen, antingen för att den var dålig förut, eller för att produkten har ändrats så mycket att det i princip handlar om att skapa en ny manual. Alltså är även den här schablonen något att ta med en nypa salt.
Hur väl stämmer schablonerna?
Om jag ser till de senaste projekten som jag har jobbat med så ligger jag snarare på 1 timme per ny sida manual, istället för 3-4 timmar per sida. Men då har jag varit involverad i andra saker runt produkten också, så en del av tiden för research och testning har rapporterats på andra poster.
Uppdateringar har snarare hamnat på 0,5 timme per sida, istället för 1 timme, men då har det handlat om produkter som jag sedan tidigare varit bekant med.
Hur estimerar du?
Jag skulle gärna höra hur andra estimerar tidsåtgång för teknisk dokumentation. Vilka parametrar tar ni med i beräkningen? Brukar estimaten stämma?
Lär dig en metod för att skriva manual
I min webbkurs Skriv en manual får du lära dig en systematisk metod för att skriva manual. Med metoden blir det lätt att komma igång, det går snabbare att skriva och resultatet blir en effektiv och lättanvänd manual.
Det här får du lära dig i kursen:
- Grundläggande principer för att skriva manual
- Metod för att avgöra vad som ska stå med i manualen och inte
- Hur du skriver instruktioner som är lätta att följa
- Olika sätt att presentera fakta på bästa sätt
- Principer för att bygga ihop och strukturera manualen
- Tips på layout som underlättar för läsaren att hitta och förstå
Gratis manualmall
Vi avslutar webbkursen med att du kan ladda ner en manualmall (den kan du ladda ner här utan att gå kursen).
Till sist visar jag hur du kan anpassa manualmallen till dina behov.
Gratis testlektion
Om du vill kan du kika på en gratislektion för att se om det verkar vara ett upplägg som passar dig.
Hör av dig om du har frågor!