At skrive en brugervejledning

Software, computere, spil og enheder kræver brugermanualer; vejledninger, der forklarer, hvordan man bruger produktet (og hvordan man ikke skal). En brugermanual er et formelt dokument med en bestemt struktur, og bør være skrevet af en person, der kender produktet til og med, såsom en teknisk skribent eller produktdesigneren. At skrive en effektiv brugermanual kræver, at du ved, hvem der skal bruge produktet, og at du skriver manualen med disse brugere i tankerne. Hold din skrivning klar, præcis og enkel for at sikre en problemfri brugeroplevelse.

Trin

Del 1 af 4: Planlægning af din brugervejledning

Billede med titlen Skriv brugervejledninger Trin 1
1. Lav en brugeranalyse. Brugervejledningen skal være skrevet til brugerne - dem, der vil købe dit produkt eller din tjeneste og læse brugervejledningen. En brugeranalyse vil fortælle dig, hvem din hoved- eller målgruppe vil være, og vil guide dig i at skrive teksten.
  • Tal med folk, der vil bruge din enhed. Giv testbrugere prototyper af enheden og et udkast til brugermanualen under kontrollerede forhold. Bed disse testbrugere om feedback på ting, der ikke er klare eller forvirrende i brugervejledningen, og foretag ændringer i din brugervejledning baseret på denne feedback.
  • Du kan aldrig glæde hele dit publikum; skrive manualen skræddersyet til målgruppen eller den største målgruppe.
  • Tænk på alder, helbred (har de nogen sygdom, indlæringsvanskeligheder eller handicap??) og offentlighedens uddannelsesniveau for at bestemme den bedste tilgang til at skrive brugermanualen.
Billede med titlen Skriv brugervejledninger Trin 2
2. Koordinere designet af brugermanualen. Hvis du var en del af teamet, der hjalp med at designe og udvikle enheden eller produktet, kan det være svært at objektivt se på produktet for at forklare, hvordan det fungerer. Du bør derfor søge råd hos en forfatter (helst en med erfaring i at skrive instruktioner) og en grafisk designer til at hjælpe dig med at udarbejde brugermanualen. Du kan vælge disse personer gennem en ekstern konsulentvirksomhed eller fra din egen virksomhed eller organisation.
Billede med titlen Skriv brugervejledninger Trin 3
3. Lav en jobanalyse. En jobanalyse er processen med at identificere og organisere de nødvendige trin for at bruge enheden. En grundig jobanalyse identificerer de materialer og udstyr (såsom batterier, medicin eller andre brugerleverede produkter), der kræves for hvert trin, samt de handlinger, fejl og fejlfindingsråd, hvert trin kan kræve.
  • Hvis du har et produkt, der kan udføre mange forskellige opgaver eller delopgaver, skal du køre en opgaveanalyse for hver opgave. For eksempel: I en bil kan du tude på dit horn, spænde dig fast og tænde eller slukke dine forlygter. Lav om nødvendigt en jobanalyse for hver af disse.
  • Billede med titlen Skriv brugervejledninger Trin 4
    4. Sørg for, at dit produkt opfylder kravene til mærkning og markedsføringstilladelse. Disse krav sikrer, at produkterne er fremstillet med brugerens sikkerhed for øje, og at brugerens eksponering for farlige forhold, såsom stråling og elektrisk stød, er begrænset. Annoncer skal klart angive formålet og de grundlæggende operationelle retningslinjer for et produkt, og du bør bruge disse ressourcer, når du skriver din brugervejledning.
  • For at et produkts brugervejledning skal være effektiv, skal den være skrevet i overensstemmelse med de etiketter, der er påsat direkte på produktet.
  • Før du skriver brugervejledningen, skal du sørge for, at din enhed har officielle licenser til salg.
  • Billede med titlen Skriv brugervejledninger Trin 5
    5. Beslut dig for layoutet af din manual. Der er flere vigtige måder, du kan strømline din manual på. Du skal sætte en fed overskrift i begyndelsen af ​​hvert afsnit med hvert ord med store bogstaver. For eksempel kan "Konfigurer din enhed", "Styr din enhed" og "Fejlfinding" alle være fed sektionsoverskrifter.
  • En anden måde at strømline din manual på er at bruge to kolonner, en til højre med tekst og den anden lige til venstre for teksten, med punkttegn, tal eller små ikoner, såsom advarselsskilte eller røde udråbstegn.
  • Manualen kan hovedsageligt bestå af billeder med noget tekst under hvert billede for at forklare enheden, eller den kan hovedsageligt være tekst med kun nogle få ledsagende billeder. Du kan også bruge et flowchart til at guide brugeren. Tænk over dit produkt, og hvordan hver metode kan hjælpe dig med at skrive din manual. Undgå dog at blande forskellige layouts i en manual. Vælg en og hold dig til den.
  • Del 2 af 4: Indlejring af væsentlig information

    Billede med titlen Skriv brugervejledninger Trin 6
    1. Organiser manualen logisk. Manualen bør være opbygget på en sådan måde, at brugeren får mest udbytte af den. Opdel manualen i kapitler eller sektioner, der giver mening for brugen af ​​produktet, og medtag en indholdsfortegnelse forrest i manualen, så hvert afsnit hurtigt kan findes.
    • En indholdsfortegnelse er især nødvendig for længere vejledninger.
    • En ordliste eller et indeks er påkrævet, hvis der er mange udtryk til at forklare, som dit publikum måske ikke kender. En ordliste anbefales dog ikke; det bedste valg er at forklare forvirrende udtryk i selve manualens tekst. Hvis du vælger at inkludere en ordliste, skal du placere den foran i manualen lige efter indholdsfortegnelsen.
    • En liste over tabeller eller figurer er kun nødvendig, hvis der er mere end et par tabeller eller figurer i manualen.
    • Der er brug for et bilag til ting, der skal forklares, men som ikke kan forklares andre steder i manualen, da det ville forstyrre flow og fokus.
    Billede med titlen Skriv brugervejledninger Trin 7
    2. Inkluder nødvendige advarsler. De generelle advarsler eller sikkerhedsoplysninger bør give information om potentielle farer, der kan opstå ved forkert brug af produktet, herunder død eller alvorlig personskade. Disse advarsler bør placeres helt forrest i manualen, efter forsiden, så brugeren ser dem først. Specifikke advarsler bør også inkluderes i vejledningens tekst lige efter eller lige før et potentielt farligt trin foreslås.
  • For eksempel kan en generel advarsel for et elektrisk apparat være ikke at bruge det i regnvejr.
  • Et specifikt signal kunne være at sikre, at både dine hænder og enheden er tørre, før du tilslutter enheden.
  • Giv billeder (såsom et kranie og krydsede knogler) eller tekst i en anden farve (såsom rød tekst) for at skelne advarslen fra resten af ​​instruktionerne i manualen og henlede brugernes opmærksomhed på det.
  • Billede med titlen Skriv brugervejledninger Trin 8
    3. Beskriv enheden. Din beskrivelse skal indeholde både en skriftlig forklaring af formålet med enheden og en lille grafisk gengivelse af, hvordan enheden ser ud. Illustrationen skal mærke og navngive alle kontakter, knapper og dele, der kan monteres i enheden.
    Billede med titlen Skriv brugervejledninger Trin 9
    4. Giv installationsinstruktioner. Installationsafsnittet bør indeholde grundlæggende oplysninger om, hvordan du forbereder dig på at bruge produktet eller enheden. Hvis enheden ikke kan bygges eller opsættes af en hjemmebruger, skal dette tydeligt angives i en fed overskrift øverst i installationssektionen. Du bør også inkludere følgende:
  • En reservedelsliste
  • Udpakningsvejledning
  • Installationsadvarsler
  • Konsekvenser af en forkert installation
  • Hvem skal man ringe til i tilfælde af installationsbesvær
  • Billede med titlen Write User Manuals Trin 10
    5. Giv driftsoplysninger. Dette afsnit er den vigtigste del af brugervejledningen og skal give konkrete, detaljerede oplysninger om, hvordan du bruger enheden. Start med den grundlæggende forberedelse, før du bruger apparatet, såsom at sætte stikket i stikket eller vaske hænder. Fortsæt med logiske, nummererede trin, der beskriver, hvordan du bruger enheden, samt feedback (f.eks. "Du hører et klik...`), som brugeren kan forvente, når enheden bruges korrekt.
  • I slutningen af ​​dette kapitel skal brugere henvises til fejlfindingskapitlet for at løse problemer, der ikke kan forklares hurtigt.
  • Post billeder, hvor det er nødvendigt. Nogle trin forklares bedst med både billeder og ord. Tænk på at bruge fotos eller illustrationer i din manual.
  • I denne del, som i enhver anden del, bør du inkludere relevante sikkerhedsadvarsler om forkert brug eller betjening. For eksempel kan du advare motorsavsbrugere om ikke at drikke alkohol eller bruge motorsaven, mens de tager visse lægemidler.
  • Hvis du tror, ​​det vil gavne brugerne, kan du overveje at inkludere links til onlinevideoer, der viser den korrekte brug og drift af enheden. Du kan inkludere disse videoer enten i begyndelsen af ​​dette afsnit eller (i tilfælde af videoer, der kun illustrerer ét trin) i slutningen af ​​hvert trin.
  • Billede med titlen Write User Manuals Trin 11
    6. Tilføj en oversigt over produktet til sidst. Resuméet skal komme i slutningen af ​​manualen, lige før indekset, for at give de grundlæggende trin i betjeningen. Dette bør være en forenklet, strippet version af driftsinformationen og bør ikke overstige én side. Opsummer, hvordan du bruger enheden eller produktet. Inkluder grundlæggende advarsler, nummererede trin, der forklarer, hvordan man bruger produktet, og telefonnumre eller e-mailadresser, der leder brugerne til at hjælpe.
  • Hvis du forventer, at brugeren fjerner oversigtsarket eller har brug for at henvise til det ofte, kan du printe det på et aftageligt lamineret kort eller tykt karton for at gøre det lettere for brugeren at bære og henvise til.
  • Alternativt kan du sætte en oversigt direkte på produktet for hurtig og nem reference for brugeren.
  • Del 3 af 4: Beskriver produktvedligeholdelsen

    Billede med titlen Write User Manuals Trin 12
    1. Forklar, hvordan du rengør enheden. Hvis din enhed eller dit produkt skal rengøres, skal du forklare, hvordan du gør det. Angiv de nødvendige rengøringsmidler. Fortæl læseren, hvor ofte den skal gøre rent. Derefter, som i enhver anden del af manualen, skal du inkludere nummererede trin-for-trin instruktioner om, hvordan du rengør.
    • Hvis rengøring kræver adskillelse af produktet eller fjernelse af en bestemt del eller dele, bedes du angive hvordan produktet skilles ad.
    • Giv en advarsel om resultaterne af manglende rengøring af enheden. For eksempel kan du sige, "Hvis enheden ikke er rengjort, vil ydeevnen være mindre end optimal.`
    Billede med titlen Write User Manuals Trin 13
    2. Tæl brugeren, hvordan man udfører grundlæggende vedligeholdelse. Hvis produktet eller enheden kan serviceres af brugeren for at rette ydeevneproblemer, skal du angive nummererede instruktioner om, hvordan dette gøres af brugeren. For eksempel: hvis batterierne skal udskiftes efter hver 300 timers brug, giv instruktioner om, hvordan man kontrollerer, om batterierne skal udskiftes, hvordan man fjerner de brugte batterier, og hvordan man isætter de nye batterier.
  • Hvis der er visse vedligeholdelsesopgaver, som kun kan udføres af en autoriseret tekniker, opdeles vedligeholdelsesafsnittet i manualen i to dele.
  • Billede med titlen Skriv brugervejledninger Trin 14
    3. Diskuter opbevaringsmuligheder. Manualen skal om nødvendigt forklare, hvordan produktet eller enheden opbevares korrekt. Du bør også medtage oplysninger om, hvorfor opbevaring er nødvendig, og hvad konsekvenserne er af forkert opbevaring. For eksempel kan du skrive:
  • `Opbevar produktet på et køligt, tørt sted. Forkert opbevaring kan forkorte dit produkts levetid på grund af fugtopbygning.`
  • `Udsæt ikke produktet for varme og opbevar det ikke ved temperaturer over 50 grader Celsius. Hvis du gør dette, kan det føre til antændelse.`
  • Billede med titlen Skriv brugervejledninger Trin 15
    4. Angiv oplysninger om fejlfinding. Du kan organisere dette afsnit som en liste over almindelige problemer og deres løsninger. Gruppér lignende problemer under en logisk overskrift. På denne måde kan brugerne hurtigt finde specifikke problemer.
  • Hvis der for eksempel er flere problemer med, at computeren viser en blå skærm, skal du gruppere dem under en underoverskrift, såsom "Almindelige skærmproblemer".
  • Du skal også inkludere et kundeservicetelefonnummer og/eller e-mail i dette afsnit.
  • Del 4 af 4: At skrive en læsevenlig vejledning

    Billede med titlen Skriv brugervejledninger Trin 16
    1. Læs andre brugervejledninger. Før du skriver en manual til dit eget produkt, skal du se på andre effektive brugermanualer. Vær opmærksom på opbygningen, valg af ord og sætningsstruktur. Store mærker som Apple, Google og Microsoft producerer stærke, effektive brugervejledninger, der kan hjælpe dig med at udarbejde en gennemtænkt skrevet brugervejledning.
    • Lad være med bare at læse alle brugermanualer. Læs manualerne for lignende produkter, du sælger. For eksempel: Hvis du sælger babyprodukter, skal du læse babymanualer, ikke tekniske.
    Billede med titlen Write User Manuals Trin 17
    2. Vælg dine standarder. Standardisering af stavning, ordvalg og formulering vil gøre brugervejledningen mere brugervenlig. Chicago Manual of Style og Microsoft Manual of Style kan også være nyttige stilguider, når du skriver din brugermanual; tjek begge for at se, om den ene passer til din manual.
  • For eksempel, i stedet for at bruge både "tænd/sluk-knap" og "tænd/sluk-knap" i din manual, skal du vælge et af de to udtryk og holde fast ved det.
  • Billede med titlen Write User Manuals Trin 18
    3. Brug den aktive stemme. Den aktive stemme er en måde at skrive på, der forklarer tingene fra brugerens perspektiv. Det er lettere at forstå end alternativet, den passive stemme, hvor subjektet er udefineret.
  • Prøv Hemingway-appen (www.hemmingwayapp.com) for at genkende passive passager i din skrift.
  • Studer disse to eksempelsætninger -- den første er aktiv og den anden passiv:
  • Du skal åbne pakken langsomt og forsigtigt.
  • Pakken skal åbnes langsomt og forsigtigt.
  • Billede med titlen Skriv brugervejledninger Trin 19
    4. Skriv nummererede instruktioner. Numerisk ordnede instruktioner hjælper læseren med bedre at fokusere på processen med at bruge, forbinde eller bygge det pågældende produkt. I stedet for at skrive et langt, udførligt afsnit eller en række unummererede afsnit, skriv din brugervejledning med enkle, eksplicitte trin, hver tydeligt nummereret.
    Billede med titlen Write User Manuals Trin 20
    5. Begynd hvert trin med et imperativ. Et imperativ er et handlingsorienteret verbum. Ved at starte hvert trin med et verbum giver du læseren et hint om den handling, der kræves for at fuldføre trinnet. Afhængigt af det produkt, du skriver om, kan du f.eks. starte dine trin med en kommando som "Forbind", "Bekræft" eller "Skub". Start dog ikke dine trin med et svar fra systemet.
  • Hvis f.eks. skærmen bliver blå og begynder at blinke, skal du ikke starte trinnet med "Skærmen blinker og bliver blå.` Prøv: `Tryk og hold hjemtasten nede. Skærmen blinker og bliver blå.`
  • Billede med titlen Write User Manuals Trin 21
    6. Bestem hvilket ordforråd du vil bruge. Hvis du skriver en brugermanual til en yo-yo, vil dit publikum hovedsageligt bestå af små børn. Brug enkle ord og ordforråd til at forklare, hvordan yo-yo`en fungerer. Hvis du skriver en scanningselektronmikroskopmanual, vil dit publikum være højtuddannede videnskabsmænd, der kan forstå meget detaljerede oplysninger, så du skal ikke vige tilbage fra at bruge specialiseret ordforråd eller nuancerede forklaringer.
  • Forsøg generelt at undgå jargon og fagsprog.
  • For at være effektiv for den bredest mulige brugerbase, prøv at skrive på et niveau fra sjette til syvende klasse.
  • Billede med titlen Write User Manuals Trin 22
    7. Når du sender et produkt til udlandet, skal du sørge for, at dine oversættelser er nøjagtige. Hyr en oversætter til at oversætte din brugervejledning til modersmålet i det land, du sender dit produkt til. Du kan også bruge et online oversættelsesværktøj, men bed en native speaker om at læse oversættelsen og tjekke for fejl.
  • Hvis flere sproggrupper er repræsenteret i dit publikum, bedes du inkludere oversættelser af brugervejledningen på hvert relevant sprog.
  • Oversætteren bør være bekendt med produktet, da der kan være andre ord på målsproget for specifikke termer, der ikke er ord-til-ord-oversættelser.
  • Billede med titlen Write User Manuals Trin 23
    8. Skriv i korte sætninger. Brug mange korte afsnit i stedet for et par lange afsnit. Se efter logiske brud i hver sektion, og fordøj nyttige oplysninger i bidder med én eller to sætninger. Det samme gælder på sætningsniveau. Hold dine sætninger korte og enkle i stedet for lange og udførlige.
  • Hvis et trin begynder at blive for langt, skal du dele det op i mindre trin. Dette vil ikke bringe ordantallet ned, men linjeskiftene vil gøre det lettere at læse.
  • Billede med titlen Skriv brugervejledninger Trin 24
    9. Tjek manualen for fejl. En manual kan miste troværdighed på grund af grammatik og stavefejl. Få en kollega eller teknisk skribent til også at redigere og korrekturlæse manualen. Ud over stavning og grammatik bør en korrekturlæser være opmærksom på følgende:
  • Passiv stemme
  • Uklart eller forvirrende sprog
  • indpakket sætningsstruktur
  • For lange afsnit
  • Tips

    • Folk lærer på forskellige måder; Hvis det er muligt og passende, skal du inkludere visuelle hjælpemidler eller links til onlinevideoer i manualen for at imødekomme visuelt orienterede læsere.

    Оцените, пожалуйста статью