Måste du vara expert på produkten för att kunna skriva en manual?

Det här är en fråga jag som teknikinformatör ofta får. Fast då snarare formulerad som “hur ska du som inte kan något om produkten kunna skriva manualen?”.

Men kanske borde vi vända på frågan? För hur ska någon som är hemmablind kunna titta på produkten med nybörjarens ögon?

Här är några fördelar med att vara skrivexpert snarare än produktexpert:

  • Du har en ny användares perspektiv.
  • Du har fokus på funktion istället för tekniken bakom.
  • Du kan hantverket när det gäller att skapa teknisk dokumentation.

Kunskapens förbannelse

Faktum är att det finns en hel del forskning som visar att det inte alls är så lätt att förklara saker som du själv är expert på. Har du hört talas om “the curse of knowledge“?

En mycket talande studie utfördes på 1990-talet av en doktorand på Stanford som lät deltagarna i studien lyssna på låtar och samtidigt “knacka melodierna”. Knackningarna spelades in. Dessa “knackare” skulle sedan bedöma hur många melodier som lyssnarna skulle känna igen efter att ha hört de inspelade knackningarna. Knackarna felbedömde å det grövsta, de trodde att lyssnarna skulle känna igen 50% av melodierna. Det faktiska resultat var 2,5%.

Många av produktexperternas manualer lider ofta av samma problematik – kunskapens förbannelse.

En ny användares perspektiv

När du som teknisk skribent tar dig an en ny manual för en produkt som du inte kan sedan tidigare, så är ditt perspektiv ganska likt den nya användarens.

Det kommer därför att vara mycket lättare för dig att avgöra vad som behöver stå i manualen och hur det ska presenteras, än vad det någonsin kommer att vara för den som kan produkten utan och innan och lätt blir hemmablind.

En expert löper större risk att göra logiska tankehopp som en ny användare inte hänger med i. Experten missar också lätt att beskriva begrepp och termer som kan vara helt nya för användaren.

Lösningen

Naturligtvis behöver du som teknisk skribent hjälp med vad användaren ska göra och hur, men det går oftast ganska fort för en expert att visa. En rutinerad teknikinformatör är van vid att sätta sig in i nya produkter.

Hemligheten ligger nämligen i att just gå igenom det som användaren ska göra i produkten. Vi ska däremot INTE gå igenom produkten bit för bit, för det är inte så en användare närmar sig en ny produkt.

Läs gärna mer om Handlar din manual om produkten eller om användaren?

 

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

Buffe med mat

Därför ska du skriva manualen som en buffé

Jag är en förespråkare av modulär teknisk dokumentation. Varför? För att det gör dokumentationen lättare att använda, lättare att skriva och framför allt lättare att uppdatera. Hur då? Modulärt julbord

Instruktioner för att laga soppa

User stories ger dig rätt instruktioner (del 2)

User stories visar vad er produkt faktiskt ska uträtta åt användaren. Eller snarare vad användaren vill göra. Du kan nu enkelt förstå vilka instruktioner som du behöver skriva. Välkommen till

Läsare av teknisk dokumentation

Fixa dokumentationen med user stories (del 1)

User stories kan ge dig en flygande start när du ska skriva teknisk dokumentation, särskilt manualer av olika slag. Det gäller oavsett om det är grundläggande manualer till slutanvändare, integrationsinstruktioner

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

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.