Att skapa dokumentation som faktiskt används

Vad menar vi med dokumentation?

När vi pratar om dokumentation och teknisk information spänner det över en enorm bredd: från dynamiska driftmanualer för operatörer av storskaliga komplexa system, till visuella steg-för-steg-instruktioner för enklare konsumentprodukter, till användarguider för mjukvara, eller policy- och processbeskrivningar och så vidare. Oavsett format och sammanhang är det centrala syftet detsamma – att snabbt och effektivt hjälpa mottagaren att lösa en specifik uppgift.

Hur skriver man dokumentation som människor faktiskt använder?

Det finns forskning som visar tydligt hur vi konsumerar teknisk information. Omfattande studier från UX-forskningsinstitutet Nielsen Norman Group slår fast att endast 16 % av användarna läser text på en skärm ord för ord. Majoriteten av användarna letar och skumläser (scannar) efter nyckelord. Forskaren John Carrolls välkända teori om minimalism inom teknikinformation visar att användare är otåliga och handlingsdrivna. De vill lösa sitt problem omedelbart.

För att informationen ska fungera väl måste den vara enkel att skumma igenom. De flesta läsarna letar efter svar på en specifik fråga. Så här ökar du användbarheten:

behandla endast ett ämne per avsnitt
börja med det viktigaste och mest konkreta
använd tydliga rubriker och underrubriker
håll stycken korta
använd punktlistor istället för långa textblock
lägg till bilder, illustrationer eller diagram när de förtydligar innehållet
undvik onödigt fackspråk – tillämpa gärna klarspråk

Användare ska snabbt kunna avgöra om ett avsnitt är relevant. Skriv därför rakt på sak och placera detaljerad information längre ner i texten.

Att arbeta utifrån fristående, modulära informationsavsnitt – ett arbetssätt som kallas för “topic-based authoring” (ämnesbaserad strukturering) – underlättar också för användare. Att bygga informationen i oberoende, ämnesspecifika delar gör dokumentation dynamisk, återanvändbar och anpassningsbar, oavsett om den i slutändan visas i en app, på en webbplats, eller sammanfogas till ett längre dokument.

Hur anpassar man dokumentationen för olika målgrupper?

Man skriver för olika målgrupper genom att anpassa språk, detaljnivå, struktur, begrepp och exempel efter läsarens kunskap, behov och syfte. Användbarheten ökar med anpassning till målgrupp och samma ämnesområde kan därför behöva presenteras på olika sätt.

Analysera målgruppen genom att ställa dessa frågor:

Vem är mottagaren av informationen?
Hur stor teknisk kunskap har mottagaren?
Vilket problem försöker de lösa?
Vilka frågor vill de ha svar på?

När målgruppen är definierad blir det lättare att avgöra hur informationen ska presenteras. En nybörjare kan behöva mer kontext, tydliga steg-för-steg-instruktioner och exempel, medan en erfaren användare vill kunna navigera direkt till specifika referensdata. När vi utgår från mottagarens förkunskaper och behov blir informationen mer relevant, begriplig och användbar.
Modulära informationsavsnitt gör det lättare att undvika fällan att använda samma detaljnivå för alla målgrupper.

Hur gör man rätt information tillgänglig för rätt person i rätt sammanhang?

För att information ska komma till nytta måste den finnas tillgänglig i det sammanhang där användaren faktiskt utför sitt arbete. Det kan åstadkommas genom att ha en tydlig struktur för målgrupper, ansvar, publicering och distribution. Det är viktigt att veta vem dokumentationen är till för, vilken information de behöver, och när de behöver den.

Avgörande faktorer:

Samla informationen på en gemensam plats.
Använd versionshantering för att göra uppdateringar spårbara.
Etablera strategier och metoder för att distribuera uppdateringar så användarna alltid ser aktuell information.
Integrera informationen i de arbetsflöden och system där den används.
Använd strukturerade metadata, t.ex. produktkategori och målgrupp.

Vilka tekniska lösningar som är bäst beror på typ av information och var användaren befinner sig. Vanliga plattformar är:

dynamiska webbportaler där användaren kan filtrera fram rätt avsnitt
strukturerade kunskapsbaser för support
en integrerad hjälpfunktion direkt i det system som användaren arbetar i.

Hur gör man dokumentationen sökbar?

Informationen blir sökbar genom att man kombinerar en logisk struktur med rätt tekniska förutsättningar:

Använd rubriker som tydligt beskriver vad avsnittet handlar om eller vilket problem det löser.
Använd konsekvent terminologi genom hela materialet. Sökmotorer och användare förvirras om samma företeelse kallas olika saker i olika texter.
Tillämpa relevanta metadata för exempelvis produktversion, ämne och målgrupp. Det möjliggör avancerad filtrering och precis sökning.
Illustrationer och diagram är i sig ofta inte sökbara. För att visuellt innehåll ska hittas behöver det förses med tydliga bildtitlar, figurnummer och alt-texter.