Sådan bygger du den bedste brugerdokumentation

chancerne er, at hvis dine produkter er mere komplekse end en rulle papirhåndklæder, opretter du en slags brugerdokumentation for at hjælpe folk med at lære at bruge dem.

en veludviklet, brugervenlig produktmanual eller brugervejledning kan betyde forskellen mellem en fantastisk kundeoplevelse og en forfærdelig.

og brugerdokumentation er ikke kun for nye brugere.,

erfarne kunder kan også henvise til brugervejledninger eller produktvejledninger for at opdatere deres minder om en funktion, de ikke har brugt ofte, eller for at løse et specifikt problem, de måtte have.

for dette indlæg fokuserer vi mest på bedste praksis for oprettelse af brugerdokumentation for ikke-fysiske produkter såsom soft .are, men de fleste, hvis ikke næsten alle disse tip, gælder også for det fysiske produktområde.

Her er hvad du vil lære:

• hvad er brugerdokumentation, og hvorfor er det vigtigt?
• hvordan slutbrugerdokumentation er en del af kundeoplevelsen.,
• hvor god brugerdokumentation kan hjælpe med at fjerne byrden fra dit kundesupportteam.
• hvorfor visuelt indhold er den hemmelige ingrediens til den bedste dokumentation.
• de væsentlige elementer, der sikrer den bedste brugerdokumentation.
• de fire trin til at skabe dokumentation, der glæder dine kunder og står tidens prøve.

Hvad er brugerdokumentation?

brugerdokumentation (også kaldet slutbrugervejledninger, slutbrugervejledninger, brugsanvisninger mv.) er det indhold, du giver slutbrugere for at hjælpe dem med at få mere succes med dit produkt eller din tjeneste.

Disse er de undervisningsmaterialer, der går med dit produkt til at hjælpe en med at lære at korrekt brug af det, eller — i tilfælde af fysiske produkter — også selv sætte det sammen.,

Hvis du nogensinde har samlet et stykke Ikea-møbler, har du brugt slutbrugerdokumentation.

men brugerdokumentation tager mange former.

videospil kommer med manualer til at fortælle dig, hvilke knapper til at skubbe til at skyde de onde. Soft .aredokumentation viser dig, hvad dit køb kan gøre, og hvordan du gør det.,

skatteformularer kommer med vejledninger om, hvordan man korrekt udfylde dem.

plæneklippere og snekastere har produktguider, der viser dig, hvordan du starter motorerne, og hvor du skal genopfylde brændstoffet.

spring ned til hvordan man laver brugerdokumentation

Hvorfor er brugerdokumentation vigtig?

du ved, at dit produkt er fantastisk. Du vil have dine kunder til at vide det, også. Brugerdokumentation hjælper med at sikre, at dine kunder eller brugere rent faktisk lærer, hvordan du får mest muligt ud af dit produkt.,

uanset om det er, hvordan du gemmer et dokument, starter en motor, bruger et specifikt værktøj eller vigtige sikkerhedsoplysninger, er din slutbrugerdokumentation en vigtig del af dit forhold til dine kunder.

det kan glæde dine kunder

brugerdokumentation er let, ikke? Jeg mener, bare Skriv nogle ting om, hvordan du bruger dit produkt, og du er god til at gå!

det er ikke helt så simpelt.

det er mere end bare “ho.-to” Materiale. Det er en del af kundeoplevelsen., Og det betyder, at det også er markedsføringsmateriale.

som forbruger har jeg selv oplevet både gode og forfærdelige brugervejledninger. Jeg vedder på, at de fleste af jer har haft lignende oplevelser.

En stor brugervejledning eller produkt guide viser dine kunder, at du er forsigtig med ikke bare om, hvorvidt de købe dit produkt, men om de har en virkelig stor oplevelse rent faktisk bruger det.

og kunder, der føler, at du holder af dem ud over deres tegnebog, vil fortsætte med at vende tilbage til dig.,

Hvis du vil have dem til at råbe til verden om, hvor meget de elsker dine produkter og tjenester, er det en vigtig del af denne oplevelse efter køb.

hvordan brugerdokumentation understøtter dit supportteam

folk kontakter dit supportteam, når noget ikke fungerer, men de ringer også, når de bare ikke kan finde ud af noget. At have god brugerdokumentation hjælper dit supportteam på to hovedmåder.

1., Giver dem en nem referencevejledning

stor brugerdokumentation behøver ikke bare at være for kunderne. Dit produktsupportteam kan bruge dokumentation til at hjælpe dine kunder bedre, når de ringer. Når du inkluderer vigtige stykker såsom en indholdsfortegnelse eller indeks, kan de hurtigt finde de oplysninger, de har brug for. Og hvis det er et søgbart elektronisk dokument, er det endnu bedre! Vi lærer mere om dette senere i artiklen.

2. Reducerer opkald

Som nævnt ovenfor kalder folk ofte support, når de ikke kan finde ud af noget., Men hvis kunderne selv kan finde ud af det, er de langt mindre tilbøjelige til at have brug for hjælp. Faktisk foretrækker mere end 70 procent af mennesker at bruge et virksomheds websiteebsted til hjælp snarere end at bruge en telefon eller e-mail. nu vil selv den bedste dokumentation ikke fjerne alle disse opkald, men at oprette brugervejledninger og manualer, der er omfattende, lette at forstå, klare og koncise, vil gå langt for at reducere den samlede mængde opkald, e-mails, chats osv.

Hvad er de væsentlige elementer i stor brugerdokumentation?,

selvom hvert produkt er unikt og vil kræve forskellige elementer for at skabe virkelig gode brugerdokumenter, er der nogle bedste praksis for slutbrugerdokumentation, der skal følges, uanset hvad.,

Great brugeren bør dokumentationen indeholde:

• forståeligt sprog
• Enkelhed
• Visuals
• fokus på problemet
• Et logisk hierarki og flow
• indholdsfortegnelsen
• Søgbare indhold
• Tilgængelig indhold
• Godt design
• Feedback fra rigtige brugere
• Links til yderligere ressourcer

forståeligt sprog

Intet vil hindre en kunde mere, end at læse noget, de ikke kan forstå. Ingen ønsker at føle sig dum., At få din kunde til at føle den måde er bestemt ingen måde at skabe en god oplevelse på.

brug simpelt, almindeligt sprog, når det er muligt for at hjælpe dine kunder med at forstå selv de mest komplekse begreber.

husk, skriv for brugeren, ikke udvikleren.

det lyder som en no-brainer, men at skrive i almindeligt sprog om et produkt eller en tjeneste, du kender front-To-back, er langt vanskeligere, end du måske tror. Du kender alle former for jargon, akronymer, og andre “insider” info, at kunderne sandsynligvis ikke. det er naturligt for dig at bruge det.,

men det er her du kan løbe ind i nogle alvorlige problemer.

Antag ikke, at din kunde ved noget om dit produkt. Antag ikke, at de kender alle de tekniske og / eller industrielle bu.. .ords, som du sandsynligvis bruger hver dag på dit kontor. Skriv det for dem.

skriv ikke som om de er børn, men forstå, at de muligvis har brug for ekstra hjælp til virkelig at få dem op i fart. Skriv dokumentationen på en letlæselig måde.

enkelhed

hold det så enkelt som muligt for at nå sit mål. Dette gælder både dokumentets indhold såvel som dets design., Lange blokke med tekst og sider tæt pakket med skriftligt og grafisk indhold kan få brugervejledninger eller manualer til at føle sig skræmmende og uvenlige.

kunder, der er skræmt af dine brugermaterialer, er langt mere tilbøjelige til at ringe til dit supportteam for at få hjælp, end de skal forsøge at løse deres spørgsmål alene. Og, de er langt mindre tilbøjelige til at have en god kundeoplevelse.

Visuals, visuals, visuals

den bedste brugerdokumentation illustrerer perfekt ordsproget, “Vis, fortæl ikke.,”

visuelt indhold, herunder billeder, annoterede skærmbilleder, grafik og videoer, viser hurtigt nogen, hvordan dit produkt fungerer. De behøver ikke at læse om, de kan se det!nyere forskning fra TechSmith viser, at folk faktisk absorberer visuel information hurtigere og udfører opgaver bedre, når instruktioner leveres med visuelt eller videoindhold.,

visuelt indhold hjælper også med at nedbryde lange tekstblokke og kan hjælpe med at fjerne meget af teksten, der kan få mange brugervejledninger eller manualer til at føle sig skræmmende og ubehagelige. populære måder at inkludere visuelt indhold i brugerdokumentation inkluderer skærmbilleder, skærmoptagelser, tutorialvideoer og mere.

har du hørt om forenklet grafik?, Nogle gange kaldes forenklet brugergrænseflade (eller SUI), forenklet grafik tager billeder af en brugergrænseflade eller anden grafik og — ligesom navnet antyder — forenkler dem. Denne mere grundlæggende version fremhæver de mest vigtige oplysninger, mens du reducerer tekst og grafik, der ikke er vigtige for enklere former.,

Så, noget der ligner dette:

Nu ser ud som dette:

Hvis jeg prøvede at vise nogen hvordan vælg Connect Mobile Device menu item, det andet billede, der fjerner alt det rod, og giver mulighed for kundens øjne til at fokusere, hvor de skal være.

chancerne er, at du allerede har stødt på forenklet grafik og ikke engang klar over det.,

Som denne fra G-Suite Learning Center:

Der er masser af værktøjer derude, men hvis du er på udkig efter kraftfuld og nem måde at lave screenshots og tv-optagelser, Jeg kan varmt anbefale downloade en gratis prøveversion af Snagit.

fokus på det problem, der skal løses

hvert produkt løser et problem., Men alt for ofte, vi er så forelsket vores seje produktfunktioner, alt, hvad vi ønsker at gøre, er at fremhæve, hvad det kan gøre snarere, at hvorfor vores kunder har brug for det.

sørg for at vise brugerne, hvordan du udfører opgaver med dit produkt.

naturligvis vil dette involvere produktfunktioner, men gør det i forbindelse med at hjælpe brugeren med at komme til grunden til, at de købte dit produkt i første omgang — for at løse et specifikt problem.,

for eksempel fremhæver vores Camtasia-og Snagit-tutorials (Ja, tutorialvideoer kan være en form for dokumentation) specifikke funktioner, men de gør det i forbindelse med, hvorfor nogen måske bruger denne funktion. Det handler om hvorfor, ikke kun hvordan.

Her er et godt eksempel …

Logisk hierarki og flow

God dokumentation, der er behov for et hierarki af positioner og underpositioner, der gør det muligt for en bruger at vide, hvad hver sektion vil vise dem., Og det hierarki skal følge et logisk Flo., der hjælper brugeren med at lære at bruge dit produkt på den mest nyttige måde.

for eksempel ønsker du sandsynligvis ikke at starte din dokumentation ved at vise dine kunder, hvordan de bruger de mere avancerede funktioner uden først at vise dem det grundlæggende i, hvordan dit produkt fungerer. Start med de nemme ting først og derefter, som dine brugere opbygge deres viden, vise dem de avancerede funktioner.,

indholdsfortegnelse

en indholdsfortegnelse giver dine kunder en enkel, effektiv og velkendt måde at hurtigt finde en løsning på deres spørgsmål eller problem. Det er lige i begyndelsen af dokumentet, så de ikke behøver at Sile gennem sider med tekst for at finde det, de leder efter. Det skal indeholde alle de vigtigste overskrifter og underpositioner som beskrevet ovenfor.

Gøre det søgbart

Der var en tid, hvor de fleste bruger dokumentation, der blev trykt., Nu, i en tid, hvor næsten alle har adgang til en smartphone, er det mere fornuftigt at oprette elektronisk dokumentation. Det betyder ikke, at du ikke kan oprette printversioner, også, men en elektronisk version giver en række fordele, vi vil nærmere ind på nedenfor.

som en indholdsfortegnelse giver søgbart indhold brugerne lettere adgang til dit indhold og hjælper dem med at finde løsninger på egen hånd.

tilgængelighed

Opret tilgængeligt indhold., Dette betyder at sikre, at elektronisk dokumentation overholder standarder for tilgængelighed for personer, der kan være blinde eller synshandicappede, døve eller hørehæmmede eller kan have kognitive handicap.

Husk, at mange af dine kunder har brug for dette for at forstå og få fuld adgang til din brugerdokumentation. Efterlad dem ikke!

godt design

Giv dine brugere et dokument, de vil se på, og de vil være mere tilbøjelige til at bruge det.

Design materialer med dine kunder i tankerne. Gør det brugbart og venligt., Undgå lange tekstafsnit eller sider, der er pakket for fulde af indhold. Tillad hvidt rum for at hjælpe med at bryde monotonien og gøre udsigten til at lære et nyt produkt mindre skræmmende.

Medtag grafik og billeder så meget som muligt for at vise frem for at fortælle dine kunder, hvordan du bruger dit produkt. Brug video og GIF ‘ er til elektronisk dokumentation.

brug konsistente skrifttyper og komplementære farver på tværs af flere dokumenter. Hvis din organisation har en stilguide (som jeg varmt anbefaler, at du skal), skal du sørge for, at din dokumentation overholder den., Snagit-skabeloner gør det utroligt nemt at oprette professionelt udseende brugerdokumentation fra en række skærmbilleder eller andre billeder. Du skal blot samle de billeder, du har brug for, vælge Opret og billede fra skabelon, og du er på vej.

Snagit leveres med en masse gratis, professionelt designede skabeloner, og med TechSmith-aktiver til Snagit får du adgang til et ton mere!

Feedback fra rigtige brugere og/eller betatestere

Du kan ikke oprette rigtig god brugerdokumentation, før du har lyttet til de mennesker uden for din organisation, der rent faktisk bruger produkterne.,

Lær deres smertepunkter og prøv at adressere dem så godt du kan. Find ud af, hvad de fortæller dig, de har brug for at vide for bedst at bruge dine produkter. Mens noget af det måske er indlysende, garanterer jeg, at du lærer ting, du aldrig engang overvejede.

Links til anden dokumentation

sørg for, at dine kunder har adgang til flere af din organisations ressourcer til, hvordan du får succes med dine produkter. For elektronisk brugerdokumentation kan dette være så simpelt som at give links til tutorials, ofte stillede spørgsmål, brugerfora og meget mere.,

men selv Udskriv dokumentation kan indeholde ting som websiteebstedsadresser og telefonnumre for yderligere support.

Bonus! Tilføj Trin-for-trin-vejledning

Trin-for-trin vejledninger hjælpe med at undgå lange blokke af tekst og give en meget klarere måde at vise en proces end at forsøge at forklare det via tekst alene. De er lettere at følge, lettere at forstå og tilbyder en meget mere brugervenlig oplevelse end blot at fortælle nogen, hvordan man udfører en opgave.,

og husk, at herunder visuelt indhold i dine trinvise instruktioner gør dem endnu bedre.

Snagit giver en super-nem at bruge trin værktøj, der hjælper dig med at skabe stor trin-for-trin dokumentation. Plus, Kombiner billeder værktøj giver dig mulighed for at kombinere individuelle screenshots og andre billeder i et enkelt billede for lettere redigering og markere.

Hvordan man kan skabe stor bruger-dokumentation

Trin 1: Planlægge

Alle store sæt af bruger-dokumenter, der begynder med en plan., Her er nogle tip til, hvordan du kommer dit sted.

ved, hvor du skal starte

mange mennesker antager, at hvis du kender dit produkt, kan du bare begynde at oprette din dokumentation, men der er meget mere, der går ind i det. Start i stedet med en plan for at sikre, at du rent faktisk hjælper dine brugere.

før du laver dokumentation, er her et par ting, du skal overveje:

• hvad skal du medtage? Hvad skal du udelade? (Tip: Det er her brugerfeedback kan være virkelig nyttigt!)
• i hvilken rækkefølge skal vi præsentere oplysningerne?, (Husk essay skitserer fra middle school? Brug dem!)
• hvilke andre ressourcer vil være tilgængelige? Hvordan vil vi give adgang/links til dem?
• Hvem er ansvarlig for at oprette dokumentet? Hvem er ansvarlig for feedback på dokumentet? Hvem har endelig godkendelse?
• skal dette oversættes eller lokaliseres?

svarene på disse spørgsmål former, hvordan du opretter din dokumentation. Planlægning sikrer en jævn proces og et bedre brugerdokument.

Kend dit produkt

sørg for at kende dit produkt.,

det betyder ikke, at du skal være den absolutte ekspert på alt, men enhver, der opretter en brugermanual eller brugervejledning, skal have praktisk erfaring med produktet. Stol på dine fageksperter for den mere dybtgående viden, men du bør vide, hvordan du bruger det selv, før du forsøger at lære en anden.

Vælg dit format

Derudover, et dokument endelige format, der er lige så vigtig. Vil det kun være trykt? Vil det være elektronisk? Hvis ja, hvor vil det bo?,

det var ikke så længe siden, at næsten al brugerdokumentation kun blev udskrevet. Men medmindre du har en meget god grund, anbefaler jeg i det mindste at have en elektronisk version tilgængelig på dit websiteebsted. de fleste brugere har 24-timers adgang til smartphones, computere eller tablets, og de er vant til at finde noget, de vil vide, når de vil vide det. At sætte brugerressourcer online giver dem adgang, uanset hvor de måtte være, hvilket betyder, at de ikke behøver at søge gennem skuffer eller arkivskabe for at finde en brugermanual, de ikke har set i år.,

det er også simpelthen lettere at gøre elektronisk dokumentation tilgængelig for handicappede. En version, der kun er trykt, fungerer for de fleste mennesker, men er du parat til at oprette en brailleversion til brugere, der kan være blinde eller synshandicappede? Hvad med brugere, der har et fysisk handicap, hvor det er svært for dem at manipulere objekter med deres hænder?

Der findes værktøjer til at gøre elektronisk dokumentation lettere for alle at få adgang til, men kun udskrivningsversioner giver et meget vanskeligere tilgængelighedsproblem.,plus, elektronisk dokumentation er meget lettere at opdatere, da den lever på nettet.

Hvis du vil tilbyde en Do .nloadbar PDF-version af din dokumentation, er det fint. Men sørg for, at det også er tilgængeligt på dit websiteebsted i et ikke-PDF-format.,

Trin 2: Opret dit brugerdokument

Når du har besvaret alle spørgsmålene og taget alle de beslutninger, der er beskrevet ovenfor, er det tid til at oprette din brugerdokumentation. Jeg vil ikke antage at fortælle dig, hvordan du nøjagtigt opretter dokumentationen til dit specifikke produkt, men der er nogle vigtige ting, du skal huske på.

• undgå jargon og meget tekniske termer undtagen når det er absolut nødvendigt (og sørg derefter for at definere dem).undgå akronymer, medmindre du forklarer, hvad de betyder.
• brug en almindeligt anerkendt skrivestil som AP eller Chicago, når det er muligt., Hvis din organisation har en guide til virksomhedsstil, skal du bruge den.
• Antag ikke, at brugeren ved noget om dit produkt eller hvad det gør. Vis dem, hvad de har brug for at vide for at få succes.
• Husk at bruge almindeligt sprog. Skriv for en ottende klasse niveau. Selv for avancerede læsere fører simpelt sprog til hurtigere behandling og bedre forståelse.
• designet skal være behageligt, ikke-skræmmende og trække brugeren ind. Få dem til at bruge din dokumentation.,

Trin 3: Test det

en brugervejledning er kun fantastisk, hvis den hjælper dine kunder med at bruge dit produkt efter bedste evne. Og det kan du ikke vide, før nogen bruger det. Før din nye skabelse går ud i verden som helhed, vil du teste den. Her er et par tips!

• bedste praksis: giv det til en gruppe rigtige brugere eller betatestere og se, hvordan de gør det. Indarbejde deres feedback i det færdige dokument.
• hvis du ikke har beta-test brugerfeedback, test det internt, helst med medarbejdere, der er mindst bekendt med produktet.,
• få feedback fra udviklere og ingeniører. De kender produktet bedre end nogen, og de kan påpege ting, du måske har gået glip af.

Trin 4: Hold din dokumentation opdateret

når dit produkt ændres, skal du alt opdateret. Som nævnt ovenfor giver dette elektronisk dokumentation en stor fordel i forhold til print. Selv udskrivnings-dokumenter kan dog opdateres og gøres tilgængelige til do .nload på dit websiteebsted.

Husk, dit indhold er kun godt, hvis det er nøjagtigt. Sørg for, at det, du giver dine kunder, faktisk hjælper dem med at bruge dit produkt.,

resum If

Hvis du ikke husker noget andet, skal du huske, at Stor brugerdokumentation skal oprettes, designes og præsenteres på en måde, der er mest nyttig for dine brugere.

giv dem dokumentation, der fortsætter med at glæde dem og giver den slags kundeoplevelse, du gerne vil have.

gør din dokumentation tilgængelig, nyttig, gør den visuel.

ofte stille spørgsmål