det här är hur man bygger den bästa användardokumentationen

chansen är att om dina produkter är mer komplexa än en rulle pappershanddukar skapar du någon form av användardokumentation för att hjälpa människor att lära sig hur man använder dem.

en väl utformad, användarvänlig Produkthandbok eller användarhandbok kan betyda skillnaden mellan en fantastisk kundupplevelse och en fruktansvärd.

och användardokumentation är inte bara för nya användare.,

erfarna kunder kan också hänvisa till bruksanvisningar eller produktguider för att uppdatera sina minnen på en funktion som de inte har använt ofta eller för att lösa ett specifikt problem som de kan ha.

För det här inlägget kommer vi främst att fokusera på bästa praxis för att skapa användardokumentation för icke-fysiska produkter som programvara, men de flesta om inte nästan alla dessa tips gäller även för den fysiska produktvärlden.

här är vad du lär dig:

• vad är användardokumentation och varför är det viktigt?
• hur slutanvändardokumentation är en del av kundupplevelsen.,
• hur bra användardokumentation kan hjälpa till att ta bort bördan från ditt kundsupportteam.
• Varför visuellt innehåll är den hemliga ingrediensen till den bästa dokumentationen.
• de väsentliga delarna som säkerställer bästa användardokumentation.
• de fyra stegen för att skapa dokumentation som glädjer dina kunder och står sig genom tiderna.

vad är användardokumentation?

Användardokumentation (även kallad slutanvändarhandböcker, slutanvändarguider, bruksanvisningar etc.) är det innehåll du ger slutanvändarna för att hjälpa dem att bli mer framgångsrika med din produkt eller tjänst.

det här är de instruktionsmaterial som följer med din produkt för att hjälpa någon att lära sig att använda den på rätt sätt eller — när det gäller fysiska produkter — till och med sätta ihop den.,

om du någonsin har monterat en bit av Ikea möbler, har du använt slutanvändardokumentation.

men användardokumentation tar många former.

videospel kommer med manualer för att berätta vilka knappar som ska tryckas för att skjuta skurkarna. Programdokumentation visar vad ditt köp kan göra och hur man gör det.,

skatteblanketter kommer med guider om hur du fyller dem ordentligt.

gräsklippare och snöslungor har produktguider för att visa dig hur du startar motorerna och var du ska fylla på bränslet.

hoppa ner för att göra användardokumentation

Varför är användardokumentation viktig?

Du vet att din produkt är bra. Du vill att dina kunder ska veta det också. Användardokumentation hjälper till att säkerställa att dina kunder eller användare faktiskt lär sig hur du får ut det mesta av din produkt.,

oavsett om det är hur du sparar ett dokument, startar en motor, använder ett specifikt verktyg eller Viktig säkerhetsinformation, är din slutanvändardokumentation en viktig del av din relation till dina kunder.

det kan glädja dina kunder

användardokumentation är lätt, eller hur? Jag menar, skriv bara några saker om hur du använder din produkt och du är bra att gå!

det är inte riktigt så enkelt.

det är mer än bara ”how-to” material. Det är en del av kundupplevelsen., Och det betyder att det också är marknadsföringsmaterial.

som konsument själv har jag upplevt både stora och hemska användarguider. Jag slår vad om att de flesta av er har haft liknande erfarenheter.

en bra bruksanvisning eller produktguide visar dina kunder att du bryr dig inte bara om huruvida de köper din produkt, men om de har en riktigt bra upplevelse som faktiskt använder den.

och kunder som känner att du bryr dig om dem bortom deras plånbok kommer att fortsätta komma tillbaka till dig.,

om du vill att de ska skrika till världen om hur mycket de älskar dina produkter och tjänster, är att tillhandahålla fantastisk användardokumentation en viktig del av den efterköpsupplevelsen.

hur användardokumentation stöder ditt supportteam

människor kontaktar ditt supportteam när något inte fungerar, men de ringer också när de bara inte kan räkna ut något. Att ha bra användardokumentation hjälper ditt supportteam på två stora sätt.

1., Ger dem en enkel referensguide

bra användardokumentation behöver inte bara vara för kunder. Din produkt supportteam kan använda dokumentation för att bättre stödja dina kunder när de ringer. När du inkluderar viktiga delar som en innehållsförteckning eller index, kan de snabbt hitta den information de behöver. Och om det är ett sökbart elektroniskt dokument är det ännu bättre! Vi lär oss mer om detta senare i artikeln.

2. Minskar samtal

som nämnts ovan, ringer folk ofta support när de inte kan räkna ut något., Men om kunderna kan räkna ut det själva är de mycket mindre benägna att behöva hjälp. I själva verket föredrar mer än 70 procent av människor att använda ett företags hemsida för hjälp i stället för att använda en telefon eller e-post.

nu kommer inte ens den bästa dokumentationen att eliminera alla dessa samtal, men att skapa användarguider och manualer som är omfattande, lätta att förstå, tydliga och koncisa kommer att gå långt för att minska den totala volymen av samtal, e-post, chattar etc.

vilka är de väsentliga delarna i bra användardokumentation?,

även om varje produkt är unik och kommer att kräva olika element för att skapa riktigt bra användar dokument, det finns några slutanvändare dokumentation bästa praxis att följa oavsett vad.,

bra användardokumentation bör innehålla:

• vanligt språk
• enkelhet
• grafik
• fokus på problemet
• en logisk hierarki och flöde
• en tabell innehåll
• tillgängligt innehåll
• bra design
• feedback från riktiga användare
• länkar till ytterligare resurser

vanligt språk

ingenting kommer att hindra en kund mer än att läsa något de inte kan förstå. Ingen vill känna sig dum., Att göra din kund känner så är verkligen inget sätt att främja en stor upplevelse.

använd enkelt, vanligt språk när det är möjligt för att hjälpa dina kunder att förstå även de mest komplexa begreppen.

Kom ihåg att skriva för användaren, inte utvecklaren.

det låter som en no-brainer, men att skriva på vanligt språk om en produkt eller tjänst som du vet är mycket svårare än du kanske tror. Du vet alla typer av jargong, akronymer och andra ”insider” info som kunder sannolikt inte. det är naturligt för dig att använda den.,

men det är där du kan stöta på några allvarliga problem.

anta inte att din kund vet något om din produkt. Anta inte att de känner till alla tekniska och / eller branschens buzzwords som du sannolikt använder varje dag på ditt kontor. Skriv det åt dem.

skriv INTE som om de är barn, men förstå att de kan behöva extra hjälp för att verkligen få dem att skynda. Skriv dokumentationen på ett lättläst sätt.

enkelhet

håll det så enkelt som möjligt för att uppnå sitt mål. Detta gäller både dokumentets innehåll och dess utformning., Långa block av text och sidor tätt packade med skriftligt och grafiskt innehåll kan göra användarguider eller manualer känns skrämmande och ovänliga.

kunder som skräms av ditt användarmaterial är mycket mer benägna att ringa ditt supportteam för hjälp än de ska försöka lösa sina frågor på egen hand. Och, de är mycket mindre benägna att ha en bra kundupplevelse.

grafik, grafik, grafik

den bästa användardokumentationen illustrerar perfekt ordspråket, ”visa, berätta inte.,”

visuellt innehåll, inklusive bilder, kommenterade skärmdumpar, grafik och videor, visar snabbt någon hur din produkt fungerar. De behöver inte läsa om, de kan se det!

ny forskning från TechSmith visar att människor faktiskt absorberar visuell information snabbare och utför uppgifter bättre när instruktioner är försedda med visuellt eller videoinnehåll.,

visuellt innehåll hjälper också till att bryta upp långa textblock och kan bidra till att eliminera en hel del av texten som kan göra många användarguider eller handböcker känns skrämmande och obehagligt.

populära sätt att inkludera visuellt innehåll i användardokumentationen inkluderar skärmdumpar, skärminspelningar, handledningsvideor och mycket mer.

har du hört talas om förenklad grafik?, Ibland kallas förenklat användargränssnitt (eller SUI), förenklad grafik ta bilder av ett användargränssnitt eller annan grafik och — precis som namnet antyder — förenklar dem. Denna mer grundläggande version markera den viktigaste informationen samtidigt minska text och grafik som inte är viktiga för enklare former.,

så, något som ser ut så här:

ser nu ut så här:

om jag försökte visa någon hur man väljer menyalternativet Anslut mobil enhet, tar den andra bilden bort allt skräp och gör att kundens ögon kan fokusera där de behöver vara.

chansen är att du redan har stött på förenklad grafik och inte ens inser det.,

gilla den här från G Suite Learning Center:

det finns många verktyg där ute, men om du letar efter kraftfulla och enkla sätt att skapa skärmdumpar och skärminspelningar rekommenderar jag starkt att du laddar ner en gratis provversion av Snagit.

fokusera på det problem som ska lösas

varje produkt löser ett problem., Men alltför ofta, vi är så kär i våra coola produktfunktioner, allt vi vill göra är att lyfta fram vad det kan göra snarare att varför våra kunder behöver det.

se till att visa användare hur du utför uppgifter med din produkt.

naturligtvis kommer detta att innebära produktfunktioner, men gör det i samband med att hjälpa användaren att komma till orsaken till att de köpte din produkt i första hand — för att lösa ett specifikt problem.,

till exempel kan våra Camtasia-och Snagit-tutorials (ja, handledningsvideor vara en form av dokumentation) markera specifika funktioner, men de gör det i samband med varför någon kan använda den funktionen. Det handlar om varför, inte bara hur.

här är ett bra exempel …

logisk hierarki och flöde

bra dokumentation behöver en hierarki av rubriker och underrubriker som låter en användare veta vad varje avsnitt ska visa dem., Och den hierarkin bör följa ett logiskt flöde som hjälper användaren att lära sig att använda din produkt på det mest användbara sättet.

till exempel vill du förmodligen inte börja din dokumentation genom att visa dina kunder hur du använder de mer avancerade funktionerna utan att först visa dem grunderna i hur din produkt fungerar. Börja med de enkla sakerna först och sedan, när dina användare bygger sina kunskaper, visa dem de avancerade funktionerna.,

innehållsförteckning

en innehållsförteckning ger dina kunder ett enkelt, effektivt och välbekant sätt att snabbt hitta en lösning på deras fråga eller problem. Det är rätt i början av dokumentet så att de inte behöver sålla igenom sidor med text för att hitta vad de letar efter. Den bör omfatta alla huvudrubriker och underrubriker som beskrivs ovan.

gör den sökbar

det fanns en tid då de flesta användardokumentation skrevs ut., Nu, i en tid där nästan alla har tillgång till en smartphone, är det mer meningsfullt att skapa elektronisk dokumentation. Det betyder inte att du inte kan skapa utskriftsversioner också, men en elektronisk version erbjuder ett antal fördelar som vi kommer in i mer detalj nedan.

som en innehållsförteckning ger sökbart innehåll användarna enklare tillgång till ditt innehåll och hjälper dem att hitta lösningar på egen hand.

tillgänglighet

Skapa tillgängligt innehåll., Detta innebär att den elektroniska dokumentationen följer tillgänglighetsstandarderna för personer som kan vara blinda eller synskadade, döva eller hörselskadade eller ha kognitiva funktionsnedsättningar.

Kom ihåg att många av dina kunder behöver detta för att förstå och fullt ut få tillgång till din användardokumentation. Lämna dem inte!

bra design

ge dina användare ett dokument de vill titta på och de kommer att vara mer benägna att använda den.

designmaterial med dina kunder i åtanke. Gör den användbar och vänlig., Undvik långa stycken av text eller sidor som är förpackade för full av innehåll. Tillåt vitt utrymme för att bryta upp monotonin och göra utsikterna att lära sig en ny produkt mindre skrämmande.

inkludera grafik och bilder så mycket som möjligt för att visa i stället för att berätta för dina kunder hur du använder din produkt. För elektronisk dokumentation, använd video och GIF.

använd konsekventa teckensnitt och kompletterande färger i flera dokument. Om din organisation har en stilguide (som jag rekommenderar att du bör), se till att din dokumentation följer den.,

Snagit-mallar gör det otroligt enkelt att skapa professionell användardokumentation från en serie skärmdumpar eller andra bilder. Samla bara de bilder du behöver, välj Skapa och bild från Mall och du är på väg.

Snagit levereras med en massa gratis, professionellt utformade mallar, och med TechSmith tillgångar för Snagit, får du tillgång till massor mer!

Feedback från riktiga användare och/eller betatestare

Du kan inte skapa riktigt bra användardokumentation förrän du har lyssnat på personer utanför din organisation som faktiskt använder produkterna.,

lär dig deras smärtpunkter och försök att ta itu med dem så gott du kan. Ta reda på vad de säger att de behöver veta för att bäst använda dina produkter. Medan en del av det kan vara uppenbart, garanterar jag att du lär dig saker du aldrig ens övervägt.

länkar till annan dokumentation

se till att dina kunder har tillgång till mer av organisationens resurser om hur du lyckas med dina produkter. För elektronisk användardokumentation kan detta vara så enkelt som att tillhandahålla länkar till handledning, Vanliga frågor, användarforum och mer.,

men även utskriftsdokumentation kan innehålla saker som webbadresser och telefonnummer för ytterligare support.

Bonus! Lägg till steg-för-steg-instruktioner

steg-för-steg-guider hjälper till att undvika långa textblock och ger ett mycket tydligare sätt att visa en process än att försöka förklara det via text ensam. De är lättare att följa, lättare att förstå och erbjuder en mycket mer användarvänlig upplevelse än att bara berätta för någon hur man slutför en uppgift.,

och kom ihåg, inklusive visuellt innehåll i dina steg-för-steg-instruktioner gör dem ännu bättre.

Snagit ger ett superlätt att använda Stegverktyg som hjälper dig att skapa bra steg-för-steg-dokumentation. Plus, verktyget kombinera bilder kan du kombinera enskilda skärmdumpar och andra bilder till en enda bild för enklare redigering och markera.

så här skapar du bra användardokumentation

Steg 1: Planera

varje bra uppsättning användardokument börjar med en plan., Här är några tips om hur du kommer dit du ska.

vet var du ska börja

många människor antar att om du känner till din produkt kan du bara börja skapa din dokumentation, men det finns mycket mer som går in i den. Börja istället med en plan för att se till att du faktiskt hjälper dina användare.

innan du gör dokumentation, här är några saker att tänka på:

• vad ska du inkludera? Vad ska du lämna ut? (Tips: det är där användarens återkoppling kan vara till stor hjälp!)
• i vilken ordning ska vi presentera informationen?, (Kom ihåg uppsats konturer från högstadiet? Använd dem!)
• vilka andra resurser kommer att finnas tillgängliga? Hur kommer vi att ge tillgång / länkar till dem?
• vem är ansvarig för att skapa dokumentet? Vem ansvarar för feedback på dokumentet? Vem har slutligt godkännande?
• kommer detta att behöva översättas eller lokaliseras?

svaren på dessa frågor formar hur du skapar din dokumentation. Planering garanterar en smidig process och ett bättre användardokument.

Känn din produkt

se till att du känner till din produkt.,

det betyder inte att du behöver vara absolut expert på allt, men alla som skapar en användarhandbok eller användarhandbok bör ha praktisk erfarenhet av produkten.

lita säkert på dina ämnesexperter för den mer djupgående kunskapen, men du borde veta hur du använder den själv innan du försöker lära någon annan.

Välj format

dessutom är ett dokuments slutliga format lika viktigt. Blir det bara tryck? Blir det elektroniskt? Om så är fallet, var kommer det att leva?,

det var inte för länge sedan som nästan all användardokumentation endast skrevs ut. Men, om du inte har en mycket bra anledning, rekommenderar jag åtminstone att ha en elektronisk version tillgänglig på din webbplats.

de flesta användare har 24-timmars tillgång till smartphones, datorer eller surfplattor, och de är vana vid att hitta något de vill veta när de vill veta det. Att sätta användarresurser online ger dem tillgång var de än kan vara, vilket innebär att de inte behöver gå söka igenom lådor eller filskåp för att hitta en bruksanvisning som de inte har sett på år.,

det är också enkelt att göra elektronisk dokumentation tillgänglig för personer med funktionshinder. En utskriftsversion fungerar för de flesta, men är du beredd att skapa en punktskriftsversion för användare som kan vara blinda eller synskadade? Vad sägs om användare som har ett fysiskt funktionshinder där det är svårt för dem att manipulera objekt med sina händer?

verktyg finns för att göra elektronisk dokumentation enklare för alla att komma åt, men versioner Med utskriftsskydd ger ett mycket svårare tillgänglighetsproblem.,

plus, elektronisk dokumentation är mycket lättare att uppdatera, eftersom den lever på webben.

om du vill erbjuda en nedladdningsbar PDF-version av dokumentationen är det bra. Men se till att den är tillgänglig på din webbplats i ett icke-PDF-format, samt.,

steg 2: Skapa ditt användardokument

När du har svarat på alla frågor och fattat alla beslut som beskrivs ovan är det dags att skapa din användardokumentation. Jag kommer inte att anta att berätta hur exakt för att skapa dokumentationen för din specifika produkt, men det finns några viktiga saker att komma ihåg.

• Undvik jargong och mycket tekniska termer utom när det är absolut nödvändigt (och var noga med att definiera dem).
• Undvik akronymer om du inte förklarar vad de betyder.
• använd en allmänt erkänd skrivstil som AP eller Chicago när det är möjligt., Om din organisation har en företagsstilguide, använd den.
• anta inte att användaren vet något om din produkt eller vad den gör. Visa dem vad de behöver veta för att bli framgångsrika.
• kom ihåg att använda vanligt språk. Skriv för en åttonde klass nivå. Även för avancerade läsare leder enkelt språk till snabbare bearbetning och bättre förståelse.
• designen ska vara tilltalande, icke-skrämmande och dra in användaren. Få dem att vilja använda din dokumentation.,

steg 3: testa det

en användarhandbok är bara bra om det hjälper dina kunder att använda din produkt efter bästa förmåga. Det vet man inte förrän nån använder den. Innan din nya skapelse går ut i världen i stort, vill du testa den. Här är några tips!

• bästa praxis: ge den till en grupp riktiga användare eller betatestare och se hur de gör. Införliva deras feedback i det färdiga dokumentet.
• Om du inte har betatestande användaråterkoppling, testa den internt, helst med anställda som är minst bekanta med produkten.,
• få feedback från utvecklare och ingenjörer. De vet produkten bättre än någon annan och de kan påpeka saker du kanske har missat.

steg 4: Håll din dokumentation uppdaterad

När din produkt ändras måste du vara uppdaterad. Som nämnts ovan ger detta elektronisk dokumentation en stor fördel jämfört med utskrift. Men även skriv bara dokument kan uppdateras och göras tillgängliga för nedladdning på din webbplats.

Kom ihåg att ditt innehåll bara är bra om det är korrekt. Se till att det du ger dina kunder faktiskt hjälper dem att använda din produkt.,

sammanfattning

om du inte kommer ihåg något annat, kom ihåg att bra användardokumentation ska skapas, utformas och presenteras på ett sätt som är till stor hjälp för dina användare.

ge dem dokumentation som fortsätter att glädja dem och ger den typ av kundupplevelse du vill ha.

Gör din dokumentation tillgänglig, användbar, gör den visuell.

Ställ ofta frågor

Obs: Det här inlägget publicerades ursprungligen i augusti 2019, men uppdaterades i September 2020 för tydlighet och för att inkludera ny information.