Handlar din manual om produkten eller om användaren?

Användarcentrerad manual

Det kan kännas svårt att hitta en bra struktur när du ska sätta igång och skriva din manual. Var ska du egentligen börja?

Om du är en skribent som kan din produkt bra ligger det nära till hands att utgå ifrån hur produkten är uppbyggd. Resultat blir då en produktcentrerad manual.

Tyvärr är en produktcentrerad manual ofta svår att använda för läsaren, som istället föredrar en användarcentrerad manual.  Låt oss titta närmare på de olika uppläggen.

Produktcentrerad manual

En produktcentrerad manual utgår ifrån hur produkten ser ut och är uppbyggd. Den beskriver till exempel meny för meny och vad användaren kan göra där och vad som krävs av it-personal och systemadministratörer för att det ska fungera och hur det ska underhållas.

Det är inte ovanligt att produktcentrerade manualer ser ut ungefär så här:

Exempel på produktcentrerad manual

Det här produktperspektivet känns enklast för den som kan produkten utan och innan, till exempel den som har utvecklat produkten eller kanske den skribent som ska skriva om produkten. Det blir en slags struktur att utgå ifrån när du börjar skriva.

Men för användaren är det här perspektivet problematiskt. Det förutsätter att användaren (i fallet med en mjukvara) ser en skärmbild och ställer sig frågan “undrar vad jag kan göra här?”. Men det är ju inte riktigt så det går till, att en användare på måfå öppnar en programvara och undrar vad som går att göra. Användaren behöver utföra något och vill veta hur.

Användarcentrerad manual

En användarcentrerad manual utgår från vad användaren ska göra med produkten.

  • Vilka uppgifter ska användaren utföra?
  • Hur ska användaren utföra uppgifterna?
  • Vad behöver användaren veta för att utföra dessa uppgifter?

En användarcentrerad innehåller ofta instruktioner i stil med den här:

Så skapar du en användarcentrerad manual

Jag tror att skribentens önskan om någon slags struktur  är den främsta anledningen till att manualer ofta blir produktcentrerade. Så hemligheten bakom att skapa en användarcentrerad manual ligger i att ha en bättre metodik som hjälper dig att utgå ifrån användaren.

Mer om det berättar jag här: Kom igång med en användarcentrerad manual.

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.