Fyra tips för en skalbar manual

Skapa skalbar användarmanual

En användarmanual som får växa fram utan struktur och strategi blir med tiden ohanterlig. Det brukar sluta med att manualen inte används eftersom den blir svår att hitta i och du varken vill, har tid eller råd att ta ett krafttag för att göra om den. För även om du skulle vilja, hur ska du ens göra för att inte hamna i samma sits igen? Hur ska du göra för att skapa en skalbar manual?

Så blir manualen skalbar och utvecklas med produkten

Här får du fyra tips för hur du skapar en användarmanual som är generisk, skalbar och enkel att uppdatera:

  1. Undvik kundspecifika lösningar i produkten som kräver särskilda instruktioner i manualen. Det innebär att du måste kommunicera kostnaden för att hantera komplexa manualer till produktledningen, så att de inser den faktiska kostnaden för kundspecifika lösningar.
  2. Undvik manuell handpåläggning. Du behöver ett bra och generiskt stylesheet som inte kräver att du manuellt fixar sidbrytningar och innehållsförteckningar i samband med publicering. Överhuvudtaget, se till hela publiceringsprocessen är så automatiserad som möjligt. Gör en checklista för vad du behöver göra för att publicera, och skriv testfall för vad du behöver testa efter publicering, såsom att se till att manualen funkar i olika webbläsare, att länkarna leder rätt och att manualen ser ok ut både i mobilformat och på stor skärm etc.
  3. Fokusera på vad användaren ska göra. Du behöver inte beskriva varenda liten detalj i manualen, fokusera på användarens huvudflöden. Huvudflöden består av dels det som användaren gör ofta, dels det som kan vara riskfyllt eller ofta går fel. När manualen fokuserar på flöden så är det inte ens säkert att manualen behöver uppdateras särskilt mycket i varje release. Läs mer om du skapar en användarcentrerad manual.
  4. Minimera antalet bilder i manualen. Om användaren kan öppna manualen från programmet så kan användaren ha manualen bredvid gränssnittet. Hänvisa till vad fönster, vyer, formulär och knappar heter. Använd det ord som står på skärmen och markera det i din text med fetstil. Böj inte det ordet utan hantera det som ett egennamn.
    Jag tar här ett exempel som handlar om hur användaren kan kopiera format från en text i Word. Jämför de här två instruktionerna:
  • Klicka på knappen för att kopiera formatet i startfliken.
  • Klicka på knappen Hämta format i fliken Start.
    • Den första raden skulle behöva kombineras med en bild där knappen och fliken är inringad.
      Den andra raden behöver inte en bild eftersom texten som användaren ska leta efter står utskriven.

Vill du ha anpassad hjälp?

Kontakta mig om du har specifika frågor om hur du kan effektivisera din hantering av användarmanualer och annan produktdokumentation.

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.