Fyra tips för en skalbar manual

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.