Kom igång med en användarcentrerad manual

Det är ganska lätt att skapa en användarcentrerad manual om du bara känner till tricken. En sådan vattendelare är uppdelningen i vad användaren ska göra och vad användaren behöver veta för att göra det. Det gör att vi kommer att hantera två olika informationstyper: Instruktioner och Fakta.

Det är en systematisk process som består av tre enkla steg:

  1. Gör en lista på de uppgifter som användaren ska utföra.
  2. Gör en lista på det som användaren behöver veta för att kunna utföra uppgifterna ovan.
  3. Sätt ihop innehållet till en manual.

Jag går igenom de tre stegen mer i detalj här nedanför.

 

Steg 1: Gör en lista på de uppgifter som användaren behöver utföra

Utnyttja att andra redan har tänkt

I den bästa av världar är produkten eller tjänsten du skriver om utvecklad med någon slags specifikation i botten. Det kanske till och med finns så kallade user stories som beskriver hur produkten är tänkt att användas? Bra! I så fall är dessa en utmärkt utgångspunkt för din lista.

Få manualskribenter har det dock så förspänt som jag beskrev ovan. Men lugn, det går att få till en bra manual även om specen en gång i tiden skrevs med kol på papyrus och sedan dess har legat orörd. Eller, som i många fall, specen bara finns i huvudet på eldsjälen som startade allt och som sedan har slutat…

Om du inte själv är insatt i den exakta användningen brukar utbildare eller supportpersonal vara bra källor till information. Och i värsta fall får du chansa lite.

Informationstyp: Instruktion

Listan på de uppgifter som användaren ska göra är i själva verket en lista över de instruktioner du behöver skriva. Varje enskild punkt på din lista blir en egen instruktion, med en egen rubrik. Varje instruktion, inklusive rubrik, kallas ett block.

En instruktion är en steg-för-steg-anvisning för HUR användaren ska göra för att utföra uppgiften. En instruktion kan se ut så här:

Jag kan skriva spaltvis om hur du bäst skriver en instruktion, men det lämnar vi nu. Du fattar vad jag är ute efter. Låt oss gå vidare till nästa steg.

 

Steg 2: Gör en lista på vad användaren behöver veta

Håll fakta separat

Du bör hålla instruktionen så ren och enkel som möjligt, vilket innebär att du inte ska lägga till bakgrundsinformation med fakta i de olika stegen. Den informationen ska du hålla separat. Så allt det där som användaren behöver veta innan hen sätter igång med en instruktion behöver du skriva upp på nästa lista. Se exemplet nedan.

Informationstyp: Fakta

Precis som i Steg 1 när vi skapade instruktioner, så blir varje punkt på din andra lista ett stycke med fakta med en egen rubrik.  Den rubriken med sitt innehåll bildar alltså också ett block.

Varje block få bara innehålla en idé. Det gör inget om det blir ganska lite innehåll i varje block, rubriken gör det lätt för användaren att veta om hen behöver läsa just det blocket eller inte.

Steg 3: Sätt ihop dina block till en manual

Princip för att bygga ihop din manual

När du har gjort alla instruktioner och alla beskrivningar som behövs för att instruktionerna ska gå att utföra så är det dags att plocka ihop alla blocken till en manual:

  1. Bygg avsnitt av block. Sätt ihop de block med instruktioner och beskrivningar som hör ihop och placera dem i ett avsnitt som har en numrerad rubrik som beskriver innehållet.
    Helst ska avsnittet inte innehålla fler än sju block, max nio, för att innehållet ska vara överskådligt för användaren.
    rad
  2. Bygg sektioner av avsnitt. Om du har mycket material, så kan du behöva sätta ihop de avsnitt som hör ihop så att de utgör en sektion som också får en numrerad rubrik som beskriver innehållet.
    Helst ska sektionen inte innehålla fler än sju avsnitt, max nio, för att innehållet ska vara överskådligt för användaren.
    rad
  3. Bygg kapitel av sektioner. Kanske behöver du även samla ihop dina sektioner till numrerade kapitel.  Samma sak gäller här – max sju (eller nio) sektioner per kapitel. Kapitlen (eller den nivå du hamnade på) ska i sin tur inte vara fler än sju (eller nio).

I bilden nedan är blockrubrikerna rödbruna för att du ska se vad som är blockrubriker och vad som är kapitel- och sektionsrubriker.

Vi summerar principerna för strukturen:

  • Max 3 numrerade rubriknivåer (kapitel, sektion, avsnitt), därefter en blockrubrik (som inte är numrerad).
  • Varje del får innehålla max sju (nio i värsta fall) undernivåer.
  • Ingen text får stå lös under en numrerad rubrik, all text ska finnas i ett block.

Det var väl inte så svårt?

 

 

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.