Dette er Hvordan du kan Bygge den Beste Dokumentasjon

Sjansene er hvis produkter er mer komplekse enn en rull med papir håndklær, kan du opprette noen form for dokumentasjon for å hjelpe folk lære å bruke dem.

En godt utformet, brukervennlig produkt manuell eller brukerhåndboken kan bety forskjellen mellom et fantastisk kundens opplevelse og en dårlig en.

Og dokumentasjon er ikke bare for nye brukere.,

Erfarne kunder kan også se brukerhåndbøker eller produktet guider for å oppdatere sine minner på en funksjon de har ikke brukt ofte eller for å løse et bestemt problem de måtte ha.

For dette innlegget, vi vil fokusere mest på beste praksis for å lage dokumentasjon for ikke-fysiske produkter, som for eksempel programvare, men de fleste om ikke nesten alle av disse tipsene gjelder også for den fysiske produktet riket.

Her er hva du vil lære:

• Hva er dokumentasjon og hvorfor er det viktig?
• Hvordan sluttbrukeren dokumentasjon er en del av kundens opplevelse.,
• Hvor god dokumentasjon kan bidra til å lette dine kundeservice.
• Hvorfor visuelt innhold, er den hemmelige ingrediensen til den beste dokumentasjon.
• De essensielle elementene som sikrer den beste dokumentasjon.
• De fire trinnene for å opprette dokumentasjon som gleder dine kunder og står testen av tid.

Hva er dokumentasjon?

Bruker dokumentasjonen (også kalt slutten bruksanvisninger, avslutter brukerhåndbøker, bruksanvisninger, etc.) er det innholdet du gi sluttbrukerne med å hjelpe dem å bli mer vellykket med ditt produkt eller tjeneste.

Dette er undervisningsmateriell som går med produktet for å hjelpe noen til å lære å skal bruke den, eller — i tilfelle av fysiske produkter — selv sette det sammen.,

Hvis du noensinne har samlet en del av Ikea-møbler, du har brukt end-user dokumentasjon.

Men, dokumentasjon tar mange former.

Video spill kommer med manualer for å fortelle deg hvilke knapper å presse til å skyte de slemme gutta. Dokumentasjonen for programvaren viser deg hva dine kjøp kan gjøre og hvordan du gjør det.,

skatteskjemaer komme med guider på hvordan du skal fylle dem ut.

Gressklippere og snøfresere har produktet guide til å vise deg hvordan å starte motorene og der for å fylle drivstoff.

gå ned til hvordan du kan gjøre brukeren dokumentasjon

Hvorfor er dokumentasjon viktig?

Du vet at produktet ditt er flott. Vil du at dine kunder skal vite det, også. Dokumentasjon bidrar til å sikre dine kunder eller brukere faktisk lære hvordan du får mest mulig ut av produktet ditt.,

Om det er hvordan du lagrer et dokument, kan du starte en motor, kan du bruke et bestemt verktøy, eller viktig sikkerhetsinformasjon din end-user dokumentasjon er en viktig del av forholdet med dine kunder.

Det kan glede dine kunder

dokumentasjon er enkelt, ikke sant? Jeg mener, bare skrive noen ting om hvordan du bruker produktet, og du er flink til å gå!

Det er ikke fullt så enkelt.

Det er mer enn bare «how-to» – materiale. Det er en del av kundens opplevelse., Og det betyr at det er også markedsføring.

Som en forbruker meg selv, jeg har opplevd både store og forferdelige brukerveiledninger. Jeg vedder på at de fleste av dere har hatt lignende opplevelser.

En stor brukerveiledning eller produkt guide viser dine kunder at du bryr deg ikke bare om de kjøper produktet, men om de har en virkelig flott opplevelse faktisk bruker det.

Og kunder som føler at du bryr deg om dem utenfor deres lommebok vil holde kommer tilbake til deg.,

Hvis du vil ha dem til å rope til verden om hvor mye de elsker dine produkter og tjenester, og gir fantastisk dokumentasjon er en viktig del av dette innlegget-kjøpet erfaring.

Hvordan du bruker dokumentasjon som støtter din støtte team

Folk kontakte support team når noe ikke fungerer, men de kan også ringe når de bare ikke kan finne noe ut. Å ha god dokumentasjon hjelper din støtte teamet i to store måter.

1., Gir dem en enkel referanse guide

Flott dokumentasjon trenger ikke bare å være for kunder. Produktet støtte team kan bruke dokumentasjon til å hjelpe bedre støtte for dine kunder når de ringer. Når du inkluderer essensielle stykker som en innholdsfortegnelse eller indeks, kan de raskt finne den informasjonen de trenger. Og, hvis det er et søkbart elektronisk dokument, som er enda bedre! Vi vil lære mer om dette senere i artikkelen.

2. Reduserer anrop

Som nevnt tidligere, folk ofte kaller støtte når de ikke kan finne noe ut., Men, hvis kundene kan finne det ut selv de er langt mindre sannsynlig til å trenge hjelp. Faktisk, mer enn 70 prosent av folk foretrekker å bruke selskapets webområde for hjelp i stedet for å bruke en telefon eller e-post.

Nå, selv den beste dokumentasjonen vil ikke eliminere alle av disse samtalene, men å lage brukerveiledninger og håndbøker som er omfattende, lett å forstå, klar og konsis vil gå en lang vei for å redusere det totale volumet av samtaler, e-post, chat-samtaler, etc.

Hva er de essensielle elementer av god dokumentasjon?,

Selv om hvert produkt er unikt og vil kreve forskjellige elementene for å skape virkelig store bruker-dokumenter, er det noen sluttbruker dokumentasjon beste praksis for å følge uansett hva.,

Flott bruker dokumentasjonen bør inneholde:

• Plain language
• Enkelhet
• Visuelle
• Et fokus på problem
• Et logisk hierarki og flyt
• En innholdsfortegnelse
• Søkbart innhold
• Tilgjengelig innhold
• God design
• Tilbakemeldinger fra reelle brukere.
• Lenker til ytterligere ressurser

Plain language

Ingenting vil frustrere kunden mer enn å lese noe de ikke kan forstå. Ingen ønsker å føle seg dumme., Gjør din kunde føler det på den måten er absolutt ingen måte å skape en flott opplevelse.

Bruke enkle, klart språk når det er mulig å hjelpe kundenes korrekt selv de mest komplekse konsepter.

Husk, skrive for brukeren, ikke utvikleren.

Det høres ut som en no-brainer, men skriver i klartekst om et produkt eller en tjeneste som du vet front-til-rygg er langt mer vanskelig enn du kanskje tror. Du vet alle slags sjargong, akronymer, og andre «insider» info at kundene sannsynligvis ikke. Det er naturlig for deg å bruke det.,

Men det er der du kan kjøre inn i noen alvorlige problemer.

ikke anta at kunden vet noe om produktet. Ikke anta at de vet alle de tekniske og/eller industri buzzwords som du sannsynligvis bruke hver dag inne på kontoret. Skrive det for dem.

ikke skriv som om de er barn, men forstår at de trenger ekstra hjelp for å virkelig få dem opp til hastighet. Skriv dokumentasjon i en lett-å-lese måte.

Enkelhet

Holde det så enkelt som mulig å oppnå sine mål. Dette gjelder både til dokumentets innhold, så vel som design., Lang blokker av tekst og sider fullpakket med skriftlig og grafisk materiell kan gjøre brukeren veiledninger eller manualer føle skremmende og uvennlig.

Kunder som er skremt av din bruker materialer som er langt mer sannsynlig å ringe support team for å få hjelp enn de er for å prøve å løse sine spørsmål på deres egen. Og, de er langt mindre sannsynlighet for å ha en god kundeopplevelse.

– Grafikk, bilder, grafikk

Den beste dokumentasjon perfekt illustrerer ordtaket, «show, don’ t tell.,»

Visuelt innhold, inkludert bilder, kommenterte skjermbilder, bilder, og videoer, raskt viser noen hvordan produktet fungerer. De trenger ikke å lese om, de kan se det!

ny forskning fra TechSmith viser at folk faktisk absorbere visuell informasjon raskere og utføre oppgaver bedre når du får instruksjoner er gitt med visuelle eller videoinnhold.,

Visuelt innhold også bidrar til å bryte opp lange tekstblokker, og kan bidra til å eliminere mye av teksten som kan gjøre mange bruker veiledninger eller manualer føle skremmende og ubehagelig.

Populære måter, inkludert visual innhold i dokumentasjon inkludere skjermbilder, screen recordings, tutorial videoer, og mer.

Har du hørt om forenklet grafikk?, Noen ganger kalles forenklet brukergrensesnitt (eller SUI), forenklet grafikk ta bilder av et brukergrensesnitt eller andre grafiske og — akkurat som navnet antyder — forenkler dem. Denne mer grunnleggende versjon fremheve de viktigste informasjonen, samtidig som den reduserer tekst og grafikk som ikke er viktig for å enklere former.,

Så, noe som ser ut som dette:

Nå ser ut som dette:

Hvis jeg prøvde å vise noen hvordan du velger å Koble Mobile Device menu element, det andre bildet fjerner alt rotet og lar kundens øyne til å fokusere der de trenger å være.

Sjansene er du har allerede møtt forenklet grafikk og ikke engang klar over det.,

Som dette fra G Suite Learning Center:

Det er mange verktøy der ute, men hvis du leter etter en kraftfull og enkel måte å lage skjermbilder og tv-opptak, Jeg anbefaler å laste ned en gratis prøveversjon av Snagit.

Fokus på det problemet som skal løses

Hvert produkt som løser et problem., Men altfor ofte, vi er så forelsket våre kule funksjoner, alle ønsker vi å gjøre er å synliggjøre hva det kan gjøre, heller det derfor våre kunder har behov for det.

sørg for å vise hvordan brukere å utføre oppgaver med produktet.

Naturlig, vil dette innebære at produktet har, men å gjøre det i sammenheng for å hjelpe brukeren komme til grunn de kjøpte produktet i første omgang — å løse et bestemt problem.,

For eksempel, våre Snagit og Camtasia tutorials (ja, tutorial videoer kan være en form for dokumentasjon) utheve bestemte funksjoner, men de gjør det i sammenheng med hvorfor noen kan bruke denne funksjonen. Det handler om hvorfor, ikke bare hvordan.

Her er et flott eksempel …

Logisk hierarki og flyt

en God dokumentasjon trenger et hierarki av overskriftene og underoverskriftene som lar brukeren vet hva hver seksjon vil vise dem., Og at hierarkiet bør følge en logisk flyt som hjelper brukeren med å lære å bruke produktet i den mest nyttig måte.

For eksempel, har du sannsynligvis ikke ønsker å starte din dokumentasjon ved å vise kundene hvordan de skal bruke de mer avanserte funksjonene uten først å vise dem det grunnleggende om hvordan produktet fungerer. Start med den enkle ting først, og deretter, som brukerne bygge opp sin kunnskap, vise dem de avanserte funksjonene.,

innholdsfortegnelse

En innholdsfortegnelse gir kundene en enkel, effektiv, og er kjent måte å raskt finne en løsning på sine spørsmål eller problem. Det er helt i begynnelsen av dokumentet, slik at de ikke trenger å sile gjennom sider med tekst for å finne det de leter etter. Det bør omfatte alle de store overskriftene og underoverskriftene som beskrevet ovenfor.

Gjøre den søkbar

Det var en tid da de fleste bruker dokumentasjon ble skrevet ut., Nå, i en tid der bare om alle har tilgang til en smarttelefon, det er mer fornuftig å lage elektronisk dokumentasjon. Det betyr ikke at du kan ikke opprette print versjoner også, men en elektronisk versjon gir en rekke fordeler vi vil inn i mer detalj nedenfor.

Som en innholdsfortegnelse, søkbart innhold gir brukerne lettere tilgang til innholdet ditt og hjelper dem å finne løsninger på egen hånd.

Tilgjengelighet

Opprett tilgjengelig innhold., Dette betyr at elektronisk dokumentasjon følger standarder for tilgjengelighet for mennesker som kan være blinde eller svaksynte, døve eller tunghørte, eller kan ha kognitive funksjonshemninger.

Husk at mange av dine kunder har behov for dette for å forstå og fullt få tilgang til dokumentasjon. Ikke la dem stå bak!

God design

Gi brukerne et dokument de ønsker å se på, og de vil være mer sannsynlig å bruke det.

Design materialet med dine kunder i tankene. Gjør det brukbart og vennlig., Unngå lange avsnitt med tekst eller sider som er pakket for full av innhold. Tillate mellomrom for å bidra til å bryte opp monotonien og gjøre utsiktene til å lære et nytt produkt for mindre skremmende.

ta med grafikk og bilder så mye som mulig for å vise snarere enn å fortelle kundene hvordan du bruker produktet. For elektronisk dokumentasjon, bruke video-og gif-filer.

Bruk konsekvent skrifter og komplementære farger på tvers av flere dokumenter. Hvis organisasjonen har en style guide (som jeg anbefaler på det sterkeste at du skal), sørg for at dokumentasjonen fester seg til den.,

Snagit maler gjør det utrolig enkelt å lage et profesjonelt utseende dokumentasjon fra en rekke skjermbilder eller andre bilder. Bare samle bilder du trenger, og velg Opprett og Bilde fra Malen, og du er på vei.

Snagit kommer med en haug med gratis, profesjonelt utformet maler, og med TechSmith Eiendeler for Snagit, kan du få tilgang til et tonn mer!

Tilbakemeldinger fra reelle brukere og/eller beta-testere

Du kan ikke lage virkelig god dokumentasjon før du har lyttet til personer utenfor organisasjonen som faktisk bruke produktene.,

finn ut sin smerte poeng og prøve å løse dem så godt du kan. Finn ut hva de forteller deg at de trenger å vite for å best bruke dine produkter. Mens noen kan det være opplagt, jeg garanterer at du vil lære ting du aldri engang vurdert.

Lenker til annen dokumentasjon

sørg for at kunder har tilgang til flere av organisasjonens ressurser på hvordan du skal lykkes med dine produkter. For elektronisk dokumentasjon, kan dette være så enkelt som å gi linker til tutorials, Faq, brukerfora, og mer.,

Men selv skrive ut dokumentasjon som kan inkludere ting som web-adresser og telefonnumre for ytterligere støtte.

– Bonus! Legg til Trinn-for-trinn-instruksjoner

Trinn-for-trinn veiledning for å unngå lange tekstblokker, og gir en mye tydeligere måte å vise en prosess enn å prøve å forklare det via tekst alene. De er enklere å følge, lettere å forstå, og tilbyr en mye mer brukervennlig opplevelse enn bare å fortelle noen hvordan å fullføre en oppgave.,

Og husk, inkludert visuelle innholdet i trinn-for-trinn-instruksjoner som gjør dem enda bedre.

Snagit gir en super-lett-å-bruke Trinn Verktøy som hjelper deg med å lage gode trinn-for-trinn-dokumentasjon. Plus, Kombinere Bilder Verktøyet gir deg mulighet til å kombinere enkelte skjermbilder og andre bilder inn i et enkelt bilde for enklere redigering og mark opp.

Hvordan å lage god dokumentasjon

Trinn 1: Planlegge

Hver stort sett av brukeren dokumenter starter med en plan., Her er noen tips om hvordan å komme dit du skal.

Vet hvor du skal begynne

Mange mennesker antar at hvis du vet produktet, kan du bare begynne å lage dokumentasjon, men det er mye mer som går inn i det. I stedet starter med en plan for å sikre at du faktisk hjelper brukerne.

Før du gjør dokumentasjon, her er et par ting du bør vurdere:

• Hva bør du ta med? Hva bør du la ut? (Hint: Dette er hvor brukeren tilbakemelding kan være VELDIG nyttig!)
• I hvilken rekkefølge skal vi presentere informasjon?, (Husk essay skisserer fra ungdomsskolen? Bruk ’em!)
• Hva andre ressurser vil være tilgjengelig? Hvordan vil vi gi tilgang/lenker til disse?
• Som er ansvarlig for å opprette dokument? Hvem er ansvarlig for tilbakemelding på dokumentet? Hvem har endelig godkjenning?
• Vil dette trenger å bli oversatt eller som er lokalisert?

svar På disse spørsmålene forme hvordan du oppretter din dokumentasjon. Planlegging sikrer en jevn prosess og en bedre bruker dokumentet.

Vet produktet

sørg for at du vet produktet.,

det betyr ikke At du trenger å være absolutt ekspert på alt, men hvem som helst opprette en bruker manuell eller brukerhåndbok bør hands-on erfaring med produktet.

Stole på emnet eksperter for mer dyptgående kunnskap, for sikker, men du bør kjenne til hvordan å bruke det selv før du prøver å lære noen andre.

Velg format

i Tillegg, et dokument er endelige formatet er like viktig. Vil det være ut-bare? Vil det bli elektronisk? Hvis så, hvor vil den live?,

Det var ikke altfor lenge siden at nesten alle bruker-dokumentasjon var bare skrive ut. Men, med mindre du har en veldig god grunn, og jeg anbefaler at du minst ha en elektronisk versjon er tilgjengelig på ditt nettsted.

de Fleste brukere har 24-timers tilgang til smarttelefoner, datamaskiner eller nettbrett, og de er vant til å finne noe de ønsker å vite når de ønsker å vite det. Å sette brukeren ressurser på nettet gir dem tilgang uansett hvor de kan være, noe som betyr at de ikke trenger å lete gjennom skuffene eller arkivskap for å finne en brukerhåndbok de ikke har sett på mange år.,

Også, det er rett og slett enklere å gjøre elektronisk dokumentasjon tilgjengelig for personer med nedsatt funksjonsevne. En print-versjonen vil fungere for de fleste, men er du forberedt på å lage en braille-versjon for brukere som kan være blinde eller svaksynte? Hva om brukere som har en fysisk funksjonshemming hvor det er vanskelig for dem å manipulere objekter med hendene?

Verktøy finnes for å gjøre elektronisk dokumentasjon lettere for alle å få tilgang til, men ut-versjoner med bare gi en mye mer vanskelig tilgjengelighet problemet.,

Pluss, elektronisk dokumentasjon er mye enklere å oppdatere, så det liv på nettet.

Hvis du ønsker å tilby en nedlastbar PDF-versjon av dokumentasjonen, er det fint. Men sørg for at den er tilgjengelig på nettstedet ditt i en ikke-PDF-format, så vel.,

Trinn 2: Opprett din bruker-dokument

Når du har besvart alle spørsmålene og laget alle de avgjørelser som er skissert ovenfor, er det på tide å lage din bruker dokumentasjon. Jeg kommer ikke til å tillate seg å fortelle deg NØYAKTIG hvordan å lage dokumentasjon for bestemte produkter, men det er noen viktige ting å huske på.

• Unngå sjargong og svært tekniske termer, bortsett fra når det er helt nødvendig (og så sørg for å definere dem).
• Unngå forkortelser, med mindre du forklare hva de betyr.
• Bruk en vanlig gjenkjent å skrive stil, slik som AP eller Chicago når det er mulig., Hvis din organisasjon har et selskap style guide, bruke den.
• ikke anta at brukeren vet noe om ditt produkt eller hva det gjør. VIS dem hva de trenger å vite for å være vellykket.
• Husk å bruke vanlig språk. Skrive for en åttende klasse nivå. Selv for avanserte lesere, enkelt språk fører til raskere behandling og bedre forståelse.
• design bør være tiltalende, ikke-skremmende, og trekke brukeren. Gjøre dem ØNSKER å bruke dine dokumentasjon.,

Trinn 3: Test det

En brukerhåndboken er bare flott om det hjelper dine kunder benytter produktet til beste evne. Og du kan ikke vite det før noen bruker det. Før den nye skapelsen går ut i den store verden, du vil teste det. Her er noen tips!

• Beste praksis: Gi det til en gruppe av reelle brukere eller beta-testere og se hvordan de gjør det. Innlemme sine tilbakemeldinger i det ferdige dokumentet.
• Hvis du ikke har beta-testing tilbakemeldinger, teste det internt, fortrinnsvis med ansatte som er minst kjent med produktet.,
• Få tilbakemelding fra utviklere og ingeniører. De vet produktet bedre enn noen, og de kan peke ut ting du kan ha gått glipp av.

Trinn 4: ta vare på dokumentasjon oppdatert

Når produktet endringer, må du alt oppdatert. Som nevnt ovenfor, dette gir elektronisk dokumentasjon en stor fordel over på skriv ut. Imidlertid, selv skrive-bare dokumenter kan være oppdatert og gjort tilgjengelig for nedlasting på nettstedet ditt.

Husk, innholdet er bare bra hvis det er riktig. Sørg for at det du gi kundene dine faktisk hjelper dem med å bruke produktet.,

Oppsummering

Hvis du husker ingenting annet, husk at god dokumentasjon bør være skapt, utviklet og presentert på en måte som er mest nyttig for brukerne.

Gi dem dokumentasjonen som fortsetter å glede dem og gir den form for kunden opplever du ønsker å ha.

Gjøre dokumentasjonen tilgjengelig, nyttig, gjøre det visuelle.

Ofte spurte spørsmål

Merk: Dette innlegget ble opprinnelig publisert på August 2019, men ble oppdatert i September 2020 for klarhet og å inkludere nye opplysninger.