Agil dokumentation tips #3: Den vanliga utvecklarmissen

Konkret abstrakt text

Utvecklare är hårt drillade i att skriva generisk kod. Jag tycker mig se att det färgar även hur utvecklare skriver dokumentation. Men är generisk text bra?

Fördelar med generisk text

Självklart är generisk text till viss del bra. Förmågan att lyfta blicken är användbar. Om du skriver modulär dokumentation, där du vill kunna återanvända vissa block på flera ställen i dokumentationen – kanske till och med för olika produkter – ja då gäller det att hålla tungan rätt i mun.

Då kan det vara lockande att skriva ”Så använder du produkten” istället för ”Så använder du Alfagrej” och ”Så använder du Betagrej”. Ska texten dessutom översättas så är det extra smidigt att generalisera, eftersom texten då bara behöver översättas en gång.

Men, det du ska ha klart för dig är att generaliseringen är smidig för dig. Inte för läsaren.

Nackdelar med generisk text

För läsaren är ordet ”produkt” en abstraktion, en variabel som ska bytas mot respektive produktnamn – Alfagrej, Betagrej, Gammagrej. Läsaren måste alltså själv stanna upp och i huvudet byta ut ”produkt” mot rätt namn. Det är alltid jobbigare för läsaren att tolka ”produkten” jämfört med ”Alfagrej”. Och ju fler generaliseringar du gör, desto mer svårläst blir texten.

När jag granskar texter är den här typen av formuleringar lite kluriga. För de är ju inte fel. Det är helt korrekt att skriva ”produkt”. Men korrekt är inte samma sak som bra.

Du kan se det som en glidande skala – en slider. Drar du åt höger blir det mer abstrakt, drar du åt vänster blir det mer konkret. Till höger hittar du ord som levande varelse eller material. Till vänster hittar du Fido eller björkträ.

Försök att dra din slider så långt åt det konkreta hållet som möjligt.

Vill du lära dig att skriva manualer?

Spanan in min webbkurs: Skriv en manual.
Du får lära dig en effektiv och systematisk metod och får personlig feedback på din nya manual!
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.