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

Buffe med mat

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 med tydlig sortering

Jo, tänk dig att du står framför ett julbord, en enorm buffé som dignar av olika rätter. Du kan välja dina sillfavoriter men kan skippa brysselkålen om du vill.
Om alla rätter däremot redan vore ihopblandade i en enda gryta skulle allt bli så mycket svårare, både för dig som ska äta och för personalen som ska fylla på med vissa rätter, eller – gud förbjude – ta bort en rätt från julbordet.

Så serveringspersonalen gör det lättare för både sig själva och för kunden genom att hålla alla rätter separata på julbordet. Dessutom brukar personalen sortera rätterna efter kallskuret, varmrätter, salladsrätter och liknande för att ytterligare underlätta ett bra flöde i matsalen. Smart!

Modulära julrecept ger flexibilitet

Kanske är liknelsen med julbord lite långt från dokumentation? Ok, men vi kan prata om receptet på en jultallrik istället. Hur blir det om vi skriver som en enda lång, integrerad text?
(Recepten kommer ursprungligen från Coop, men jag har skrivit om för att de ska passa mina syften.)

Hur blir det om vi delar upp receptet på jultallriken i moduler?

 

Vissa skulle kanske hävda att den första, långa texten ger ett bättre flöde. Det kan möjligen stämma om kocken vill göra alla rätterna och inget annat.

Men vad händer om kocken bara vill laga den ena rätten? Eller om du som skribent vill lägga till en rätt till på jultallriken? Hur lätt är att det lägga till eller ta bort en rätt i den långa texten jämfört med den modulära texten?

Lättare att anpassa presentationssättet efter innehållet

Med väl avgränsade moduler har du dessutom chansen att presentera informationen på det sätt som passar just den typen av information på bästa sätt. Precis som soppa bäst serveras i skålformat kärl, medan rökt lax är lättare att ta av från ett fat, så är det lättare att få en överblick av ingredienser om de presenteras i en lista istället för i löptext. Tillagningsanvisningarna bör däremot stå i en stegvis instruktion.

Buffé istället för gryta

Så tänk dig din dokumentation som en buffé av information, med väl avgränsade block. Gör det lätt för användaren att ta del av innehållet genom att ta en tydlig och informativ rubrik och genom att presentera informationen på bästa sätt.


Hur ser dina manualer ut? Buffé eller gryta?

Läs mer om modulär dokumentation

Är din dokumentation agil?

 

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.