Hvordan skrive klare og konsise brukermanualer
Hva er en brukermanual?
Det er forskjellige navn på en brukerhåndbok. Tekniske dokumenter, vedlikeholdsmanualer og instruksjonsmanualer er alle navn som refererer til det samme elementet. En brukermanual er laget for å hjelpe kundene med å bruke produktet eller tjenesten på riktig måte eller løse problemer som oppstår under bruk. De kan gjøres tilgjengelige i trykt, digitalt eller begge formater.
Bruksmanualer gir sluttbrukeren omfattende, trinnvise instruksjoner og noe støtte for problemer. En innholdsfortegnelse bør være til stede i hver brukerhåndbok fordi de er referansemateriale i stedet for bøker som bør leses fra begynnelse til slutt. Du bør legge til en hurtigstart- eller oppstartsveiledning i brukermanualen din, slik at brukerne lett kan føle seg vel til å begynne å bruke produktet.
typer brukermanualer
For en rekke emner og formål kan det lages brukermanualer. Her er noen av mulighetene dine, så la oss se på dem.
- Bruksanvisning
En bruksanvisning er en type brukerveiledning som gir enkle instruksjoner for bruk av et produkt slik det var tenkt brukt. - Treningsmanual
Denne typen brukerveiledning tilbyr en liste med retningslinjer for å fullføre en bestemt oppgave, prosjekt eller jobb. - Servicehåndbok
Servicemanualer er brukerveiledninger som beskriver hvordan man tar vare på og vedlikeholder et maskineri eller utstyr på forskjellige stedertagav dens levetid. - Brukerhåndbok
Brukerhåndbøker er tekniske publikasjoner som forklarer hvordan du bruker eller betjener et produkt riktig. - Bruksanvisning
Roller, plikter og prosedyrer som er spesifikke for en virksomhet eller organisasjon er beskrevet i driftshåndbøker. - Håndbok for organisasjonspolitikk
En organisasjonspolicyhåndbok er dokumentasjonen som definerer et selskaps retningslinjer, praksis og beste praksis. - Standard Operating Procedures (SOPs) Manual
Brukere drar nytte av en standard bruksanvisning med detaljerte instruksjoner for å utføre etablerte prosedyrer.
Hvorfor trenger bedriften din brukermanualer?
Folk er bedre rustet til å håndtere problemer på egenhånd med støtte fra en brukermanual. En anstendig brukerhåndbok kan gi kundene verktøyene de trenger for raskt og effektivt å oppnå verdien de ønsker av produktet eller tjenesten i dagens umiddelbare tilfredsstillelseskultur.
Utmerket kundeservice må suppleres med brukermanualer. Å skrive utmerkede brukermanualer vil gi følgende advantages for din bedrift:
- For å gjøre onboarding og opplæring enklere
Velskrevne brukerveiledninger kan gjøre onboarding og opplæringsprosedyrer enklere. Det er riktig, ved å utvikle og implementere førsteklasses brukermanualer vil både dine ansatte og dine forbrukere tjene.
Din bedrift kan bruke brukerveiledninger for å hjelpe nyansatte med å gå gjennom noen av prosessene og systemene som er en del av deres nye roller, i stedet for bare å sette opp vanskelige personlige treningsøkter, som har betydelige tids- og økonomiske utgifter. Fordi ansatte kan lære mens de utfører oppgavene knyttet til stillingene sine på grunn av brukerveiledningene, kan det gå færre timer tapt under ombordstigning. - For å redusere støtteutgifter
Brukerveiledninger er et flott tillegg til kundeserviceinnsatsen for forbrukeren, men de tjener også bedriftseieren godt som en del av kundestøttesystemet.
Det er mer sannsynlig at kunder finner løsninger med en gang og trenger mindre sannsynlighet for å kontakte en tekniker eller representant for spesialisert støtte når du gir dem rask tilgang til en søkbar brukerveiledning. - For å spare tid
Både dine kunder og dine ansatte, fra nybegynnere til ledelsen, kan spare tid ved å bruke brukermanualer. Når brukermanualer er tilgjengelige for kundene dine, trenger de ikke å kaste bort tid på å finne informasjon om hvordan du bruker et produkt fordi de vil ha direkte tilgang til den informasjonen med en gang.
Når dine ansatte er utstyrt med nyttige brukermanualer, trenger de ikke å kaste bort tid på å selvstendig lete opp løsninger eller monopolisere oppmerksomheten til sine medarbeidere og ledere med henvendelser fordi de har tilgang til løsningene rett i brukermanualen deres! - For å minimere ansvar
En tilnærming for å demonstrere at du har testet produktet ditt grundig og vet hvordan du bruker det sikkert, er å skrive og distribuere brukermanualer. Dette kan redusere eventuelle forpliktelser knyttet til å produsere noe for allmennheten betydelig.
Å ha advarsler og sikkerhetstiltak skrevet ned og gjort tilgjengelig for brukere via en brukerveiledning er en effektiv (men ikke idiotsikker) måte å unngå juridiske problemer knyttet til skader eller annen skade forårsaket av misbruk hvis produktet du selger kan være farlig for brukerne (tenk varmeovner, elektroverktøy osv.).
Hvilke komponenter utgjør de beste brukermanualene?
Det er noen beste fremgangsmåter for sluttbrukerdokumentasjon å følge uansett, selv om hvert produkt er unikt og vil trenge forskjellige komponenter for å generere virkelig utmerket brukerdokumentasjon.
- Klart språk
Ingenting vil irritere kundene dine mer – bortsett fra å ikke tilby en – enn å oppdage at brukerveiledningen deres er full av sjargong og vanskelig å forstå språk. Brukerinstruksjonene dine er vanskelige å bruke på grunn av disse språkvalgene, som heller ikke fremmer fremragende kundeservice. Å sørge for at du skriver for brukeren, ikke utvikleren, er en avgjørende komponent for å lage gode brukerveiledninger. Ikke anta at sluttbrukeren din vet eller er kjent med noe. Akronymer, sjargong og kontorterminologi vil få kundene til å føle seg feilinformerte, frustrerte og uforberedte. Det søte stedet for å lage en brukerhåndbok er å finne en balanse mellom å ikke skrive som om forbrukerne dine er barn (med mindre de er det selvfølgelig!) og å gi dem den ekstra hjelpen de trenger for å forstå hvordan de bruker produktet, på en enkel måte. Språk. - Enkelhet
Å skrive en brukerhåndbok krever at ting er enkelt. Dette konseptet bør gjenspeiles i både innholdet og designet. Hvis du overfyller dokumentasjonen med intrikate bilder og lange tekststykker, vil den virke for sofistikert og vanskelig å forstå. Denne typen brukerveiledning vil sannsynligvis skremme brukeren din og få dem til å ringe hjelpelinjen din i stedet for å prøve å finne ut av problemet på egen hånd. - Visuals
Maksimen "Vis, ikke fortell" er en hjørnestein i skriving av brukermanualer. Annoterte skjermbilder, filmer og annet visuelt innhold er svært nyttig for å forstå konsepter. Det er ofte mye mer nyttig å se noe i aksjon enn å lese om det. Visuelle elementer bryter ikke bare opp lange passasjer med tekst, men de reduserer også mengden tekst i brukermanualer som kan være skummelt. Det har blitt vist at folk beholder visuell informasjon 7 % raskere enn skriftlig informasjon. I en Techsmith-studie ble det også vist at 67 % av menneskene utførte oppgaver mer effektivt når de fikk instruksjoner som inkluderte kommenterte skjermbilder i stedet for ord alene for å formidle informasjon. - Fokuser på problemet som skal løses
Det er ganske sannsynlig at noen har kjøpt produktet ditt for å løse et problem. Det er viktig å holde fokus på dette problemet når du utarbeider brukermanualen som følger med produktet. I stedet for å oppregne og diskutere alle funksjonene produktet tilbyr eller de spennende designelementene du har inkorporert, informer brukerne om dem på en måte som letter bruken av produktet. Sett problemet som løses i sammenheng med produktets funksjoner og fordeler når du beskriver dem. - Logisk flyt og hierarki
For å gjøre det tydelig for brukeren hva de vil lære fra hver del av brukerhåndboken din, bruk overskrifter og underoverskrifter som følger en klar hierarkisk struktur. For å enkelt lede kundene dine gjennom alt de trenger å vite fra begynnelse til slutt, bør hierarkiet du velger følge en logisk flyt. Sørg for at du starter med det grunnleggende og innlemmer en logisk progresjon mot produktets mer sofistikerte funksjoner. - Innholdsliste
Brukerveiledningen din vil være mest nyttig for leserne hvis den begynner med en innholdsfortegnelse. Uten å måtte grave gjennom mange sider med informasjon som ikke er relatert til det aktuelle problemet de står overfor, er det en kjent tilnærming for noen å raskt og enkelt utforske et dokument. - Gjør det søkbart
Selv om du kanskje skriver ut brukermanualene dine, er det sannsynlig at digital dokumentasjon vil være din hovedprioritet. Det er ganske sannsynlig at brukermanualene dine vil bli brukt oftest i digitalt format i en verden hvor de fleste har en smarttelefon med seg til enhver tid. Å legge til en søkbar funksjon i dine digitale brukermanualer vil fremme en herlig brukervennlighet for brukere som ønsker å løse et problem ved å få tilgang til det, på samme måte som en innholdsfortegnelse tjener til å lede brukere til riktig plass i et trykt dokument. - Tilgjengelighet
Det er mulig at noen av personene som trenger brukerhåndboken din kan dra nytte av ekstra hjelp for å sikre at den fungerer som den skal. Uavhengig av om de er lovpålagte, er tilgjengelighetskrav generelt god praksis. Å opprettholde tilgjengelighetskravene i brukermanualene dine er bare utmerket forretningspraksis. Utforming av brukerveiledninger med innhold som er tilgjengelig for brukere som kan ha visuelle, hørbare eller kognitive utfordringer er avgjørende. - Godt designet
Vurder publikum når du lager brukerveiledningene dine. De vil være langt mer tilbøyelige til å bruke den effektivt hvis du lager noe de liker å se på! Unngå å bruke lange tekstblokker og gi rikelig med mellomrom. Å kombinere disse to egenskapene kan hjelpe forbrukere til å virke mindre skremmende og få det til å lære noe nytt til å virke spennende i stedet for truende. «Vis, ikke fortell»-tilnærmingen vi beskrev tidligere, gjelder også her. For både trykte og digitale brukermanualer er det et utmerket alternativ å legge til bilder og bilder i teksten. For digitale brukermanualer tilbyr videoer og GIF-er interesse og et nyttig element. Hvis bedriften din har en stilguide, bør designet følge den; ellers, hvis du opererer uten en, er det avgjørende å holde brukerveiledningen konsekvent. Skrift- og fargeskjemaene som brukes gjennom hele papiret, og ideelt sett på tvers av alle brukerhåndbøkene dine, bør være konsekvente. - Kommentarer fra faktiske kunder eller betatestere
Du vil ikke kunne avgjøre om brukerveiledningene du har utarbeidet er så vellykkede som mulig før du har oppsøkt og lyttet til tilbakemeldinger fra personene som faktisk skal bruke produktet ditt. Brukerveiledningene du utvikler for produktet ditt bør ta hensyn til problemene folk har med det. Du lærer kanskje noe som virker ekstremt åpenbart, men det er mye større sjanse for at du lærer noe som vil hjelpe deg å forstå behovene til kundene du prøver å nå.
Hvordan skriver jeg en brukermanual?
Å lage en brukermanual er en avgjørende oppgave som kan ha stor innvirkning på både din bedrift og forbrukerne du ønsker å betjene. Vi har forenklet prosessen med å utvikle en brukermanual slik at du enkelt kan følge med fordi det kan være overveldende.
- Identifiser brukerne
Å finne mottakeren av kommunikasjonen din er et viktig første skritt, akkurat som med all annen kommunikasjon du genererer. Brukerhåndbokens tiltenkte målgruppe vil hjelpe deg med å bestemme spørsmål som tonen, detaljnivået som skal gis og hvordan du skal levere innholdet. Å skrive en brukerveiledning for sluttbrukeren av produktet ditt er vesentlig forskjellig fra å skrive en for en teknisk ingeniør. Det aller første trinnet er å bestemme målgruppen din. - Fokuser på problemet
Brukermanualer er laget for å hjelpe med problemløsning eller instruere noen om hvordan man kan gjøre noe nytt. Du må bestemme nøyaktig hva brukerveiledningen er ment å gjøre og sørge for å opprettholde dette fokuset.
Det kan være fristende å utvide emnet og diskutere en rekke funksjoner eller applikasjoner for produktet ditt. Dette kan frustrere brukere og føre til anrop til kundestøttelinjen din ved å skjule det ekte svaret de trenger.
Hvis kunden din er en forbruker som lærer å bruke produktet eller en tekniker som trenger å fikse det, konsentrer deg om den nøyaktige løsningen de trenger. - Bruk en sekvensiell tilnærming
Brukerhåndbokens instruksjoner bør legges ut i den rekkefølgen som er nødvendig for å fullføre det aktuelle arbeidet. List opp hvert trinn for å starte. Prøv deretter å gjøre oppgaven mens du følger de nøyaktige trinnene du har skissert i den gitte rekkefølgen. Når du går gjennom den opprinnelige listen din, er det mulig, kanskje til og med sannsynlig, at du finner noen stagsom mangler. I tillegg kan du finne ut at noe du en gang trodde var en enkelt oppgave faktisk må deles inn i flere aktiviteter for klarhetens skyld.
Sørg for at du har spesifisert et klart resultat for hvert sekvensielle trinn du har tildelt før du går videre til neste fase av å skrive en brukerveiledning. Før de går videre til neste nivå, bør leserne være helt klare på hva de vil ha oppnådd og hvordan det skal se ut. - Kartlegg brukerreise
Å forstå hvordan forbrukerne planlegger å bruke produktet ditt og gjøre det enkelt for dem å gjøre det, er målet med å lage en brukerveiledning. Du må anstrenge deg for å forstå problemet forbrukeren prøver å løse eller målet de prøver å oppnå ved å bruke løsningen din, samt hvordan de engasjerer seg i virksomheten din. Du kan planlegge trinnene som er nødvendige for å veilede kunden gjennom prosessen ved å bruke disse detaljene for å visualisere deres reise fra problem til løsning. - Velg en mal
Oppgaven med å skrive og utvikle brukermanualer kan gjøres mye enklere enn du kanskje forventer ved å lage en serie maler. Prosedyren din kan være strømlinjeformet, og konsistens vil bli et mye mer realistisk mål.
I brukermanualmalen din bør du i tillegg til å definere detaljer som fonter (type og størrelse), kontrastkrav og fargeskjemaer også inkludere følgende:- Område tildelt for en introduksjon
- Distinkte underseksjoner og seksjoner
- Ditt valgte format for å formidle en rekke handlinger
- Advarsler og advarsler
- Område tildelt for konklusjon
- Skriv enkelt og lett å følge innhold
Brukerhåndbokens materiale skal være så enkelt og enkelt å forstå som mulig. Det er viktig å tenke på og analysere formatet og innholdet for klarhet og bekvemmelighet.
Sørg for at hver fase av prosessen kun skisserer én oppgave og bruker et så klart og kort språk som mulig. Sørg for å endre teksten på riktig måte til du har en brukerhåndbok som bare inneholder den informasjonen som virkelig er nødvendig. - Tilnærm hver bruker som en nybegynner
Anta at leseren av brukerhåndboken din ikke har noen forkunnskaper om produktet ditt når du oppretter det. Skriv som om du snakker til en lekmann.
All bruk av sjargong eller fagspråk bør unngås. Naturligvis vil det være tider når det må unngås, men disse bør være det absolutte unntaket. - Test produktets instruksjoner med nybegynnere
Testfasen av opprettingsprosessen for brukermanualen er avgjørende. Eksperimentemnet har en betydelig innvirkning på resultatet.
Testing bør ideelt sett gjøres på personer som aldri har brukt produktet ditt eller sett dokumentasjonen. Når du går gjennom brukerhåndboken, se dem mens de fullfører prosessen og registrere hvor de sitter fast. Deretter bør informasjonen oppdateres på riktig måte.
Kun hjelp fra brukerhåndboken skal være nødvendig for at testerne skal kunne betjene produktet. De burde ikke be om mer hjelp. USSR-guiden bør ha all informasjonen de trenger. - Bygg innhold ved hjelp av en praktisk tilnærming
Det bør gjøres alt for å tilby konkrete eksamples og detaljerte beskrivelser av eventuelle utfall som brukere kan oppleve etter å ha fulgt hvert trinn i brukerhåndboken. Brukeren bør være oppmerksom på eventuelle tilbakemeldinger de kan få fra produktet, så vel som mulige syn eller lyder de kan støte på underveis. - Forklar symboler, ikoner og koder tidlig
Det kan hende du må bruke ikoner, symboler eller koder mens du skriver en brukerveiledning for å gi de nødvendige instruksjonene. For å hindre leserforvirring eller frustrasjon, er det avgjørende å identifisere disse så tidlig som mulig i brukermanualen din.
Brukerhåndbok vanlige spørsmål
Hva er egentlig brukermanualer?
Brukerdokumentasjon er informasjon gitt i form av brukermanualer eller brukerveiledninger og er ment å hjelpe sluttbrukere med å samhandle med et produkt på en vellykket måte.
- Hva slags brukerdokumentasjon finnes det?
Fysisk dokumentasjon, som hefter eller manualer, har tradisjonelt blitt brukt for å tilby brukerdokumentasjon. I disse dager produseres og distribueres brukermanualer oftere digitalt. - Hva står i brukermanualene?
En bruksanvisning eller brukerveiledning bruker god design, tydelig skrift og et problemløsningsfokus. Jeg må ha en innholdsfortegnelse, følge et logisk hierarki og flyt, og tilby innhold som er tilgjengelig. I tillegg vil en god bruksanvisning være søkbar og ta hensyn til bruker vedrviews. - Hvordan lages et brukerdokument?
Enkle trinn kan brukes til å utvikle brukermanualer. Brukerveiledningens mål må først fastsettes, og det må utvikles en strategi for å gjøre det mulig å oppnå dem. Brukermanualen må testes og oppdateres ved behov før den publiseres. Til slutt er det viktig å holde brukerveiledningen oppdatert, og gjøre endringer etter hvert som nye oppdateringer eller utgaver legges til.