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 från en lista över IP-adresser till beskrivningar av arbetsflöden. En del lathundar innehåller så mycket information att de börjar lika en smärre manual.

Vad utmärker en lathund?

Det som utmärker en lathund är att den är tänkt att hjälpa användaren i en viss specifik situation. Du skriver för en viss verksamhet, snarare än för en viss produkt. Ofta har den kommit till för att lösa ett problem som någon blivit frustrerad över.

Här är några exempel på vad en lathund kan hjälpa till med:

  • vilka inställningar du måste göra för att kunna koppla upp din privata dator till kontorets nätverk
  • vad du som ny användare måste göra första gången du använder systemet
  • vad du ska registrera i vilket i system i samband med ett systembyte.

Står inte det i manualen?

En manual gäller oftast för en generell produkt och behöver då vara lite allmänt hållen. Då kan manualen inte gå in i detalj för vad som gäller för varje enskild verksamhet med alla lokala konfigurationer. 

Ta Outlook som exempel. Microsofts manual är kollogigantisk. Och ändå kan den inte besvara din fråga om hur du ska söka efter ett mötesrum med videoutrustning, eftersom Microsoft inte vet hur just ni har konfigurerat för ert kontor.

En lathund kan ibland handla mer om rutinerna runt omkring, snarare än hur du ska utföra det i systemet. Ska du exempelvis skanna in dina kvitton och bifoga dem i reseräkningen eller ska du skicka in dem med snigelpost? Den typen av information står definitivt inte i manualen för reseräkningssystemet!

Nå, hur ska du då göra för att få till en bra lathund?

Tips #1: Beskriv målet i rubriken

Lite otippat saknas faktiskt ofta rubriken helt och hållet i lathundar. Min teori är att det beror på att många lathundar tillkommer i affekt. Någon har helt enkelt lackat ur på att antingen:

a) alla andra gör fel, som skribenten sedan får lida för

b) skribenten själv gör fel eller får lägga mycket tid på att ta reda på hur man gör varje förbannad gång som reseräkningen ska in. Eller när larmet går. Eller, ja, du förstår.

Och när man är mitt uppe i det så är det ju självklart vad lathunden är till för. Men det är förmodligen inte alls lika självklart när någon annan ska använda lathunden två veckor senare.

Dessutom är ambitionsnivån på en lathund oftast rätt mycket lägre än för en mer formell manual.  Du vill ju gå rakt på sak. Lösa problemet! Vilket gör att du kanske skippar några av de vanliga delarna. Det leder oss till nästa tips…

Tips #2: Ange metadata

När du har öst ur dig allt du vill säga och lugnat ner dig lite, gå då tillbaka och skriv till ett stycke med information om tillblivelsen. 

  • Vem har skrivit? 
  • I vilket syfte?
  • Datum?
  • Programversion (eller annan relevant info om sammanhanget)?

Tips #3: Skriv exakta och kompletta instruktioner

Även om det är vissa specifika steg som användarna brukar fastna på, så var noga med att skriva ner exakt alla steg om du skriver en instruktion. Några lösryckta uppmaningar tagna ur sitt sammanhang blir helt obegripliga. Så ta med alla de triviala stegen också, så att flödet blir komplett.

Missförstå mig inte. Du behöver inte skriva den kompletta manualen och beskriva alla funktioner. Men den enskilda instruktionen för det problem du vill lösa måste vara komplett.

Du kan tänka på att en bra instruktion ska berätta VAD användaren ska göra, VARFÖR och HUR. 

Här är ett exempel med reseräkningarna:

VAD:
Du måste biifoga dina kvitton med reseräkningen.

VARFÖR:
Ekonomiavdelningen behöver kvittona som verifikationer vid bokföringen.

HUR:

  1. Skanna dina kvitton så att de skickas som pdf:er i via e-post till din inbox. 
  2. Spara pdf-kvittona på din dator.
  3. Bifoga pdf-kvittona i steget Verifikationer i reseräkningssystemet.
Så. Gå nu och skriv den där lathunden. Se till att få den ur systemet. Jag lovar att det kommer att kännas bättre sedan. 
 

Läs mer

Eller vill du en gång för alla veta vad som är likheten mellan teknisk dokumentation och kompost?
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

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

Är din dokumentation agil?

Ni har en agil utvecklingsprocess. Check. Ni har kanske till och med skickat ledningen på kurs och har nu en agil organisation i stort. Toppen! Men hur står det till

Vad kostar en manual

Vad kostar en manual?

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

Illustrerad instruktion

6 olika sätt att skriva instruktioner

Det finns många olika sätt att skriva instruktioner. Ett format är inte nödvändigtvis bättre än ett annat. Flera faktorer styr vilken typ av instruktion som fungerar bäst:  personliga preferenser: vissa

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.