Läsa, förstå och komma ihåg?

Elbil

Jag fattar inte varför vår elbil inte har växlar, jag erkänner.

Förut tänkte jag att den var automatväxlad, men vet numera att så inte är fallet. Den har helt enkelt inga växlar. Och jag fattar inte hur det kan komma sig.

Men det går bra att köra elbilen ändå. Jag måste inte veta hur motorn – eller den obefintliga växellådan – fungerar. Jag måste bara veta hur man kör bilen.

Vad har elbilens motor med manualer att göra?

Ett vanligt feltänk när vi skriver manualer är vi vill förklara hela funktionaliteten för användaren, i tron att om användaren förstår systemet, så kan hen själv välja hur hen vill använda det.

Det är en god tanke, men det lägger väldigt mycket ansvar och jobb på användaren.

Teori om kokkonst eller ett enkelt recept

Jämför med om vi skulle tänka likadant när det kom till matlagning. Istället för ett vanligt ”gör så här”-recept så skulle då läsaren få veta vilken koagulationstemperatur fiskens protein har, smältpunkten för fettet i lammkotletten samt hur mycket fibrer och vitaminer som paprikan, gurkan och sockerärterorna innehåller.

Då kunde ju läsaren själv kan välja hur mycket av varje ingrediens som borde ingå för ett lämpligt näringsinnehåll, samt räkna ut lämplig värme för ugn och stekpanna. Och så vidare.

Läsa, förstå och komma ihåg allt

Med ett sådant upplägg skulle du definitivt utbilda läsaren, som skulle bli mer självständig och fri framöver, men receptet (manualen) skulle bli lång och måste läsas från A till Ö för att vara användbar.

Läsaren måste dessutom verkligen läsa, förstå och komma ihåg allt för att därefter kunna dra rätt slutsatser och applicera dem på sin matlagning. Det är inte lite det.

Learning by doing

Ett lättare, och vanligare, alternativ är helt enkelt att ange vilka mängder av ingredienserna som rekommenderas och därefter skriva en steg för steg-instruktion med en föreslagen tågordning. Som ett vanligt recept.

Efter att ha lagat ett antal maträtter brukar sedan de flesta förstå principen för tillagning och kan därefter laga mat mer fritt.

Beskriva produkten eller förklara hur man gör?

Hur ser era manualer ut idag? Redogör de för hur systemet är uppbyggt och vad som händer om användaren klickar på olika knappar?

Eller hjälper de användaren att nå sina mål genom enkla steg-för-steg-instruktioner?

Du kan läsa mer om skillnaden mellan produktcentrerad och användarcentrerad manual i ett tidigare inlägg.

Tips: testa ett soloäventyr om fotboll!

Här följer skamlös reklam för mitt fritidsintresse:

Jag har skrivit och publicerat ett soloäventyr om fotbolls-EM och publicerat det online. Det är alltså en bok där du styr vad som händer och där målet är att vinna EM 2022. Det är helt gratis och passar alla nyfikna – såväl vuxna som barn.

Välkomna att testa!

Jag hjälper dig med metoder, kunskap och erfarenheter kring produktdokumentation så att den blir både effektiv och användbar.

Fler inlägg

Elbil

Läsa, förstå och komma ihåg?

Jag fattar inte varför vår elbil inte har växlar, jag erkänner. Förut tänkte jag att den var automatväxlad, men vet numera att så inte är fallet. Den har helt enkelt

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

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.