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?

Står inte det i manualen?

En manual gäller oftast för en generell produkt och behöver vara 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.

Då kan du behöva skriva en lathund för hur just ni på ert kontor bokar mötesrum.

En lathund kan också 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!

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.

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 får lida för och därför vill hjälpa dem göra rätt från början

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 du är mitt uppe i det så är det ju självklart vad lathunden är till för och en rubrik känns i princip överflödig. 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, såsom rubriken. 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)?

Ditt framtida jag, och alla andra läsare, kommer att tacka dig.

Tips #3: Skriv exakta och kompletta instruktioner

Även om det är vissa specifika steg som användare brukar fastna på, och som gör att du nu skriver den här lathunden, så var noga med att ta med exakt alla steg om du skriver en instruktion. Lösryckta uppmaningar tagna ur sitt sammanhang blir helt obegripliga. Så ta med även de triviala stegen så att flödet blir komplett.

Missförstå mig inte. Du behöver inte skriva den fullständiga 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 bifoga 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?

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

Fler inlägg

förädla din braindump

Förädla din braindump

Braindumps kan vara en guldgruva Nu kanske du som känner mig börjar undra om jag har slagit hårt i huvudet? I alla fall du som hört mig beklaga mig över

Gör dina tabeller lättlästa

Tabellen är teknikinformatörens bästa vän. Men bara om du gör den lättläst. Ett vanligt problem är att tabellen inte innehåller någon luft alls. Kanske i ett försök att spara plats?

Zooma lagom mycket

Lilla skärmdumpsskolan del 5: Anpassa storleken

Ibland visar du bara en liten detalj i bilden, ibland behöver du visa hela fönstret. Men hur stor och inzoomad bör bilden egentligen vara? Följ tips nummer fem i lilla skärmdumpsskolan

Undvik stötande innehåll

Lilla skärmdumpsskolan del 2: Visa rätt data

Ofta behöver vi som skriver manualer ta skärmdumparna i någon slags test- eller QA-miljö för att hinna få manualen klar innan mjukvaran går i produktion. Och vi har nog alla

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.