Sådan skriver du klare og præcise brugervejledninger
Hvad er en brugermanual?
Der er forskellige navne på en brugervejledning. Tekniske dokumenter, vedligeholdelsesmanualer og instruktionsmanualer er alle navne, der refererer til det samme emne. En brugermanual er lavet for at hjælpe kunder med at bruge dit produkt eller service korrekt eller løse problemer, der opstår under brug. De kan gøres tilgængelige i trykt, digitalt eller begge formater.
Brugsmanualer giver slutbrugeren omfattende, trinvise instruktioner og noget support til problemer. En indholdsfortegnelse bør være til stede i hver brugermanual, fordi de er referencematerialer snarere end bøger, der bør læses fra start til slut. Du bør tilføje en hurtigstart eller opstartsvejledning i din brugermanual, så brugerne let kan føle sig godt tilpas ved at begynde at bruge produktet.
slags brugermanualer
Til en række emner og formål kan der fremstilles brugermanualer. Her er nogle af dine muligheder, så lad os se på dem.
- Instruktionsmanual
En instruktionsmanual er en type brugervejledning, der giver enkle instruktioner til at bruge et produkt på den måde, det var beregnet til at blive brugt. - Træningsvejledning
Denne form for brugervejledning tilbyder en liste over retningslinjer for færdiggørelse af en bestemt opgave, projekt eller job. - Servicemanual
Servicemanualer er brugervejledninger, der beskriver, hvordan man passer og vedligeholder et stykke maskiner eller udstyr på forskellige stedertagaf dens levetid. - Brugermanual
Brugervejledninger er tekniske publikationer, der forklarer, hvordan man bruger eller betjener et produkt korrekt. - Betjeningsmanual
Roller, pligter og procedurer, der er specifikke for en virksomhed eller organisation, er beskrevet i driftsvejledninger. - Organisationspolitik manual
En organisationspolitikmanual er den dokumentation, der definerer en virksomheds politikker, praksis og bedste praksis. - Standard Driftsprocedurer (SOP'er) Manual
Brugere drager fordel af en standard betjeningsproceduremanuals detaljerede instruktioner til udførelse af etablerede procedurer.
Hvorfor har din virksomhed brug for brugervejledninger?
Folk er bedre rustet til at håndtere problemer på egen hånd med støtte fra en brugermanual. En anstændig brugermanual kan give dine kunder de værktøjer, de har brug for, for hurtigt og effektivt at opnå den værdi, de ønsker af dit produkt eller din tjeneste i nutidens umiddelbare tilfredsstillelseskultur.
Fremragende kundeservice skal suppleres med brugermanualer. At skrive fremragende brugermanualer vil give følgende advantages for din virksomhed:
- For at gøre onboarding og træning lettere
Velskrevne brugervejledninger kan gøre onboarding og træningsprocedurerne enklere. Det er korrekt, ved at udvikle og implementere førsteklasses brugermanualer kan både dine medarbejdere og dine forbrugere vinde.
Din virksomhed kan bruge brugervejledninger til at hjælpe nyansatte med at gennemgå nogle af de processer og systemer, der er en del af deres nye roller, i stedet for kun at oprette vanskelige personlige træningssessioner, som har betydelige tids- og økonomiske udgifter. Fordi medarbejdere kan lære, mens de udfører de opgaver, der er relateret til deres stillinger, takket være brugervejledningerne, kan der gå færre timer tabt under onboarding. - For at reducere støtteudgifter
Brugervejledninger er et godt supplement til din kundeserviceindsats for forbrugeren, men de tjener også virksomhedsejeren godt som en del af kundesupportsystemet.
Kunder er mere tilbøjelige til at finde løsninger med det samme og er mindre tilbøjelige til at skulle kontakte en tekniker eller repræsentant for at få specialiseret support, når du giver dem hurtig adgang til en søgbar brugervejledning. - For at spare tid
Både dine kunder og dine medarbejdere, fra entry-level personale til ledelse, kan spare tid ved at bruge brugermanualer. Når brugermanualer er tilgængelige for dine kunder, behøver de ikke at spilde tid på at finde information om, hvordan man bruger et produkt, fordi de vil have direkte adgang til disse oplysninger med det samme.
Når dine medarbejdere er udstyret med nyttige brugermanualer, behøver de ikke at spilde tid på selvstændigt at finde løsninger eller monopolisere deres kollegers og lederes opmærksomhed med forespørgsler, fordi de har adgang til løsningerne lige i deres brugermanual! - For at minimere ansvar
En tilgang til at demonstrere, at du har testet dit produkt grundigt og ved, hvordan du bruger det sikkert, er at skrive og distribuere brugervejledninger. Dette kan sænke eventuelle forpligtelser i forbindelse med at producere noget til den brede offentlighed markant.
At få advarsler og sikkerhedsforanstaltninger nedskrevet og gjort tilgængelige for brugerne via en brugervejledning er en effektiv (men ikke idiotsikker) måde at undgå juridiske problemer i forbindelse med skader eller anden skade forårsaget af misbrug, hvis det produkt, du sælger, kan være farligt for brugerne (tænk rumvarmere, elværktøj osv.).
Hvilke komponenter udgør de bedste brugermanualer?
Der er nogle bedste praksisser for slutbrugerdokumentation at overholde, uanset hvad, selvom hvert produkt er unikt og har brug for forskellige komponenter for at generere virkelig fremragende brugerdokumentation.
- Klart sprog
Intet vil irritere dine kunder mere – bortset fra ikke at tilbyde en – end at opdage, at deres brugermanual er fyldt med jargon og svært at forstå sprog. Dine brugervejledninger er svære at bruge på grund af disse sprogvalg, som heller ikke fremmer enestående kundeservice. At sikre, at du skriver til brugeren, ikke udvikleren, er en afgørende komponent i at skabe gode brugervejledninger. Gå ikke ud fra, at din slutbruger ved eller er bekendt med noget. Akronymer, jargon og kontorterminologi vil få dine kunder til at føle sig misinformerede, frustrerede og uforberedte. Det søde sted at lave en brugermanual er at finde en balance mellem ikke at skrive, som om dine forbrugere er børn (medmindre de selvfølgelig er det!) og at give dem den ekstra hjælp, de har brug for til fuldstændigt at forstå, hvordan man bruger produktet, helt enkelt. Sprog. - Enkelhed
At skrive en brugerhåndbog kræver, at tingene er enkle. Dette koncept bør afspejles i både indholdet og designet. Hvis du overfylder din dokumentation med indviklede billeder og lange tekststykker, vil den fremstå for sofistikeret og svær at forstå. Denne form for brugervejledning vil sandsynligvis skræmme din bruger og få dem til at ringe til din hjælpelinje i stedet for at prøve at finde ud af deres problem på egen hånd. - Visuals
Maksimen "Vis, fortæl ikke" er en hjørnesten i brugermanualskrivning. Annoterede skærmbilleder, film og andet visuelt indhold er yderst hjælpsomme til at forstå begreber. Det er ofte meget mere nyttigt at se noget i aktion end at læse om det. Visuals opdeler ikke kun lange tekststykker, men de reducerer også mængden af tekst i brugervejledninger, der kan være skræmmende. Det er blevet påvist, at folk bevarer visuel information 7 % hurtigere end skriftlig information. I en Techsmith-undersøgelse blev det også vist, at 67 % af mennesker udførte opgaver mere effektivt, når de fik instruktioner, der inkluderede kommenterede skærmbilleder i stedet for ord alene for at formidle information. - Fokuser på det problem, der skal løses
Det er ret sandsynligt, at nogen har købt dit produkt for at løse et problem. Det er vigtigt at holde fokus på dette problem, når du udarbejder den brugervejledning, der følger med produktet. I stedet for at opregne og diskutere alle de funktioner, dit produkt tilbyder, eller de spændende designelementer, du har inkorporeret, skal du informere dine brugere om dem på en måde, der letter produktets brug. Sæt problemet ved at blive løst i sammenhæng med dit produkts funktioner og fordele, når du beskriver dem. - Logisk flow og hierarki
For at gøre det tydeligt for brugeren, hvad de vil lære af hvert afsnit i din brugervejledning, skal du bruge overskrifter og underoverskrifter, der følger en klar hierarkisk struktur. For ubesværet at lede dine kunder gennem alt, hvad de behøver at vide fra start til slut, bør det hierarki, du vælger, følge et logisk flow. Sørg for, at du starter med det grundlæggende og inkorporerer en logisk progression i retning af dit produkts mere sofistikerede funktioner. - Indholdsliste
Din brugervejledning vil være mest nyttig for læserne, hvis den begynder med en indholdsfortegnelse. Uden at skulle grave gennem mange sider med information, der ikke er relateret til det aktuelle problem, de står over for, er det en velkendt tilgang for nogen hurtigt og nemt at udforske et dokument. - Gør det søgbart
Selvom du måske udskriver dine brugermanualer, er det sandsynligt, at digital dokumentation vil være din hovedprioritet. Det er ret sandsynligt, at dine brugermanualer vil blive brugt oftest i digitalt format i en verden, hvor de fleste mennesker har en smartphone med sig hele tiden. Tilføjelse af en søgbar funktion til dine digitale brugermanualer vil fremme en dejlig brugervenlighed for brugere, der ønsker at løse et problem ved at få adgang til det, på samme måde som en indholdsfortegnelse tjener til at lede brugere til det rigtige sted i et trykt dokument. - Tilgængelighed
Det er muligt, at nogle af de mennesker, der har brug for din brugervejledning, kan drage fordel af ekstra hjælp til at sikre, at den fungerer korrekt. Uanset om de er lovpligtige, er tilgængelighedskrav generelt god praksis. At vedligeholde tilgængelighedskrav i dine brugermanualer er bare fremragende forretningspraksis. Det er afgørende at designe brugervejledninger med indhold, der er tilgængeligt for brugere, der kunne have visuelle, hørbare eller kognitive udfordringer. - Godt designet
Overvej dit publikum, når du opretter dine brugervejledninger. De vil være langt mere tilbøjelige til at bruge det effektivt, hvis du laver noget, de nyder at se på! Undgå at bruge lange tekstblokke og giv masser af hvid plads. Kombinationen af disse to egenskaber kan hjælpe forbrugerne til at virke mindre skræmmende og få det at lære noget nyt til at virke spændende snarere end truende. "Vis, fortæl ikke"-tilgangen, vi beskrev tidligere, gælder også her. For både trykte og digitale brugermanualer er tilføjelse af billeder og billeder til teksten et fantastisk alternativ. For digitale brugermanualer tilbyder videoer og GIF'er interesse og et nyttigt element. Hvis din virksomhed har en stilguide, skal dit design følge den; ellers, hvis du arbejder uden en, er det afgørende at holde din brugervejledning konsekvent. Skrifttypen og farveskemaerne, der bruges i hele papiret, og ideelt set på tværs af alle dine brugervejledninger, bør være konsekvente. - Kommentarer fra faktiske kunder eller betatestere
Du vil ikke være i stand til at afgøre, om de brugervejledninger, du har udarbejdet, er så succesfulde som muligt, før du har opsøgt og lyttet til feedback fra de personer, der rent faktisk skal bruge dit produkt. De brugervejledninger, du udvikler til dit produkt, bør tage højde for de problemer, som folk har med det. Du lærer måske noget, der virker ekstremt tydeligt, men der er meget større chance for, at du lærer noget, der hjælper dig med at forstå behovene hos de kunder, du forsøger at nå.
Hvordan skriver jeg en brugermanual?
At lave en brugermanual er en afgørende opgave, som kan have stor betydning for både din virksomhed og de forbrugere, du ønsker at betjene. Vi har forenklet processen med at udvikle en brugermanual, så du nemt kan følge med, fordi det kan være overvældende.
- Identificer brugerne
At finde modtageren af din kommunikation er et væsentligt indledende skridt, ligesom med enhver anden kommunikation, du genererer. Din brugervejlednings tilsigtede målgruppe vil hjælpe dig med at beslutte dig for spørgsmål som tonefaldet, detaljeringsgraden, der skal angives, og hvordan indholdet skal leveres. At skrive en brugervejledning til slutbrugeren af dit produkt er væsentligt anderledes end at skrive en til en teknisk ingeniør. Det allerførste skridt er at bestemme dit publikum. - Fokuser på problemet
Brugermanualer er lavet for at hjælpe med problemløsning eller instruere nogen i, hvordan man gør noget nyt. Du skal bestemme præcist, hvad din brugervejledning er beregnet til, og sørge for at bevare dette fokus.
Det kan være fristende at udvide emnet og diskutere adskillige funktioner eller applikationer til dit produkt. Dette kan frustrere brugerne og føre til opkald til din kundesupportlinje ved at skygge for det ægte svar, de har brug for.
Hvis din kunde er en forbruger, der lærer at bruge produktet, eller en tekniker, der skal reparere det, skal du koncentrere dig om den præcise løsning, de har brug for. - Anvend en sekventiel tilgang
Brugervejledningens instruktioner skal udformes i den rækkefølge, der er nødvendig for at afslutte det forestående arbejde. Angiv hvert trin for at starte. Så gør en indsats for at udføre opgaven, mens du overholder de præcise trin, du har skitseret i den givne rækkefølge. Når du gennemgår din originale liste, er det muligt, måske endda sandsynligt, at du vil finde nogen stagder mangler. Derudover vil du måske opdage, at noget du engang troede var en enkelt opgave faktisk skal opdeles i flere aktiviteter for overskuelighedens skyld.
Sørg for, at du har angivet et klart resultat for hvert sekventielle trin, du har tildelt, før du går videre til næste fase med at skrive en brugervejledning. Inden du går videre til næste niveau, bør læserne være helt klare over, hvad de vil have opnået, og hvordan det skal se ud. - Kortlæg brugerrejse
At forstå, hvordan dine forbrugere planlægger at bruge dit produkt og gøre det nemt for dem at gøre det, er målet med at producere en brugervejledning. Du skal gøre en indsats for at forstå det problem, forbrugeren forsøger at løse, eller det mål, de forsøger at opnå ved at bruge din løsning, samt hvordan de engagerer sig i din virksomhed. Du kan planlægge de nødvendige trin for at guide kunden gennem processen ved at bruge disse detaljer til at visualisere deres rejse fra problem til løsning. - Vælg en skabelon
Opgaven med at skrive og udvikle brugermanualer kan gøres meget enklere, end du måske forventer ved at lave en række skabeloner. Din procedure kan være strømlinet, og konsekvens ville blive et meget mere realistisk mål.
I din brugermanualskabelon skal du ud over at definere detaljer som skrifttyper (type og størrelse), kontrastkrav og farveskemaer også inkludere følgende:- Område afsat til introduktion
- Særskilte underafsnit og sektioner
- Dit valgte format til at formidle en række handlinger
- Advarsler og advarsler
- Område tildelt til konklusion
- Skriv enkelt og let at følge indhold
Din brugermanuals materiale skal være så ligetil og enkelt at forstå som muligt. Det er vigtigt at tænke over og analysere formatet og indholdet for overskuelighed og bekvemmelighed.
Sørg for, at hver fase af processen kun skitserer én opgave og anvender et så klart og kort sprog som muligt. Sørg for at ændre din tekst korrekt, indtil du har en brugervejledning, der kun indeholder de oplysninger, der virkelig er nødvendige. - Tilgå hver bruger som en nybegynder
Antag, at læseren af din brugermanual ikke har nogen forudgående viden om dit produkt, når du opretter det. Skriv, som om du taler til en lægmand.
Enhver brug af jargon eller fagsprog bør undgås. Naturligvis vil der være tidspunkter, hvor det skal undgås, men disse bør være den absolutte undtagelse. - Test produktets instruktioner med nybegyndere
Testfasen af processen til oprettelse af brugermanualen er afgørende. Emnet for forsøget har en væsentlig indflydelse på resultatet.
Test bør ideelt set udføres på personer, der aldrig har brugt dit produkt eller set dokumentationen. Når du bevæger dig gennem brugermanualen, kan du se dem, mens de fuldfører processen og registrere, hvor de sidder fast. Derefter bør oplysningerne opdateres korrekt.
Kun hjælp fra brugervejledningen skulle være nødvendig for at dine testere kan betjene produktet. De burde ikke bede om mere hjælp. USSR-guiden bør have alle de oplysninger, de har brug for. - Byg indhold ved hjælp af en praktisk tilgang
Der bør gøres alt for at tilbyde konkrete examples og detaljerede beskrivelser af eventuelle resultater, som brugere kan opleve efter at have fulgt hvert trin i brugervejledningen. Brugeren skal være opmærksom på enhver feedback, de måtte få fra produktet, samt eventuelle potentielle syn eller lyde, de måtte støde på undervejs. - Forklar symboler, ikoner og koder tidligt
Du skal muligvis bruge ikoner, symboler eller koder, mens du skriver en brugervejledning for at hjælpe med at give de nødvendige instruktioner. For at forhindre læserforvirring eller frustration er det afgørende at identificere disse så tidligt som muligt i din brugermanual.
Brugervejledning ofte stillede spørgsmål
Hvad er brugermanualer helt præcist?
Brugerdokumentation er information, der leveres i form af brugermanualer eller brugervejledninger og er beregnet til at hjælpe slutbrugere med at interagere med et produkt med succes.
- Hvilken slags brugerdokumentation findes der?
Fysisk dokumentation, såsom hæfter eller manualer, er traditionelt blevet brugt til at tilbyde brugerdokumentation. I disse dage produceres og distribueres brugervejledninger oftere digitalt. - Hvad er indeholdt i brugervejledninger?
En instruktionsmanual eller brugervejledning bruger godt design, tydelig skrift og et problemløsningsfokus. Jeg skal have en indholdsfortegnelse, overholde et logisk hierarki og flow og tilbyde indhold, der er tilgængeligt. Derudover vil en god brugermanual være søgbar og tage højde for bruger vedrviews. - Hvordan laves et brugerdokument?
Simple trin kan bruges til at udvikle brugermanualer. Brugervejledningens mål skal først fastlægges, og der skal udvikles en strategi for at muliggøre gennemførelsen af dem. Brugermanualen skal testes og opdateres efter behov, før den offentliggøres. Endelig er det vigtigt at holde brugervejledningen opdateret, idet der foretages ændringer efterhånden som nye opdateringer eller udgaver tilføjes.