Indhold

• At træde
• Del 1 af 4: Planlægning af din brugervejledning
• Del 2 af 4: Integrer vigtige oplysninger
• Del 3 af 4: Beskrivelse af produktvedligeholdelse
• Del 4 af 4: Skriv en læsbar manual
• Tips

Software, computere, spil og enheder kræver brugermanualer; guider, der forklarer, hvordan man bruger produktet (og hvordan man ikke). En brugervejledning er et formelt dokument med en bestemt struktur og skal skrives af en person, der kender produktet indefra og ud, såsom en teknisk forfatter eller produktdesigneren. At skrive en effektiv brugervejledning kræver, at du ved, hvem der vil 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.

At træde

Del 1 af 4: Planlægning af din brugervejledning

1. Lav en brugeranalyse. Brugervejledningen skal skrives til brugerne - dem, der køber dit produkt eller din service og læser brugervejledningen. En brugeranalyse vil fortælle dig, hvem din hoved- eller målgruppe vil være, og vil guide dig gennem skrivningen af ​​teksten.
   • Tal med folk, der vil bruge din enhed. Tilby testbrugere prototyper af enheden og udkast til brugermanual under kontrollerede forhold. Bed disse testbrugere om feedback på ting, der er uklare eller forvirrende i brugervejledningen, og foretag ændringer i din brugervejledning baseret på denne feedback.
   • Du kan aldrig tilfredsstille hele dit publikum; skriv manualen skræddersyet til målgruppen eller det største publikum.
   • Overvej alder, sundhed (har de nogen sygdomme, indlæringsvanskeligheder eller handicap?) Og publikums uddannelsesniveau til at bestemme den bedste tilgang til skrivning af brugervejledningen.
2. Koordiner designet af brugervejledningen. Hvis du var en del af det team, der hjalp med at designe og udvikle enheden eller produktet, kan det være svært at tage et objektivt kig på produktet for at forklare, hvordan det fungerer. Du bør derfor søge råd fra en forfatter (helst en person med erfaring med at skrive instruktioner) og en grafisk designer for at hjælpe dig med at forberede brugervejledningen. Du kan vælge disse mennesker gennem en ekstern konsulentvirksomhed eller fra din egen virksomhed eller organisation.
3. Lav en opgaveanalyse. 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 til hvert trin, samt de handlinger, fejl og råd til fejlfinding, som hvert trin kan kræve.
   • Hvis du har et produkt, der kan udføre mange forskellige opgaver eller underopgaver, skal du udføre en opgaveanalyse for hver opgave. For eksempel: i en bil kan du tønde, binde dig ind og tænde eller slukke forlygterne. Lav om nødvendigt en jobanalyse for hver af disse.
4. Sørg for, at dit produkt opfylder kravene til mærkning og markedsføringstilladelse. Disse krav sikrer, at produkter fremstilles med brugerens sikkerhed i tankerne, og at brugerens eksponering for farlige forhold, såsom stråling og elektrisk stødning, er begrænset. Annoncer skal klart angive formålet med og grundlæggende retningslinjer for et produkt, og du skal bruge disse ressourcer, når du skriver din brugervejledning.
   • For at et produkts brugervejledning skal være effektiv, skal den skrives i overensstemmelse med de etiketter, der er anbragt direkte på produktet.
   • Sørg for, at din enhed er licenseret til salg, inden du skriver brugervejledningen.
5. Beslut dig for layoutet på 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 "Opsæt din enhed", "Betjen din enhed" og "Fejlfinding" alle være fede sektionsoverskrifter.
   • En anden måde at strømline din guide på er at bruge to kolonner, den ene til højre med tekst og den anden lige til venstre for teksten med punkttegn, tal eller små ikoner, såsom advarselsmærker eller røde udråbstegn.
   • Manualen kan hovedsageligt bestå af billeder med noget tekst under hvert billede for at forklare enheden, eller det kan hovedsagelig være tekst med kun få få ledsagende billeder. Du kan også bruge et rutediagram 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: Integrer vigtige oplysninger

1. Organiser manualen logisk. Manualen skal være struktureret på en sådan måde, at brugeren får mest udbytte af den. Opdel manualen i kapitler eller sektioner, der giver mening at bruge produktet, og inkluder en indholdsfortegnelse foran i manualen, så hvert afsnit hurtigt kan findes.
   • En indholdsfortegnelse er især nødvendig for længere manualer.
   • En ordliste eller et indeks er nødvendigt, hvis der er mange udtryk, der forklarer, at dit publikum muligvis ikke er fortrolig med. En ordliste anbefales dog ikke; det bedste valg er at forklare forvirrende udtryk i selve manualen. 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.
   • Et bilag er nødvendigt for ting, der skal forklares, men som ikke kan forklares andetsteds i manualen, da det ville forstyrre flow og fokus.
2. Inkluder nødvendige advarsler. De generelle advarsler eller forsigtighedsoplysninger bør give oplysninger om potentielle farer forårsaget af forkert brug af produktet, herunder død eller alvorlig personskade. Disse advarsler skal placeres helt foran i manualen efter forsiden, så brugeren ser dem først. Specifikke advarsler bør også medtages i teksten i manualen lige efter eller lige før et potentielt farligt trin foreslås.
   • For eksempel kan en generel advarsel for et elektrisk apparat være at ikke bruge det, når det regner.
   • En specifik instruktion kan være at sikre, at både dine hænder og enheden er tørre, før du slutter enheden til stikkontakten.
   • Giv billeder (såsom kraniet og krydsede knogler) eller tekst i en anden farve (såsom rød tekst) for at skelne advarslen fra resten af ​​vejledningen i IFU og henlede brugernes opmærksomhed på den.
3. Beskriv enheden. Din beskrivelse skal indeholde både en skriftlig forklaring af enhedens formål og en lille grafisk gengivelse af, hvordan enheden ser ud. Figuren skal mærke og navngive alle kontakter, knapper og dele, der kan fastgøres i enheden.
4. Giv installationsinstruktioner. Installationsafsnittet skal indeholde grundlæggende oplysninger om, hvordan du forbereder dig på at bruge produktet eller enheden. Hvis apparatet ikke kan bygges eller opsættes af en hjemmebruger, skal du tydeligt angive dette med en fed overskrift øverst i installationsafsnittet. Du bør også medtage følgende:
   • En deleliste
   • Udpakningsinstruktioner
   • Installationsadvarsler
   • Konsekvenser af forkert installation
   • Hvem skal man ringe til i tilfælde af problemer under installationen?
5. Giv oplysninger om operationen. Dette afsnit er den vigtigste del af brugervejledningen og skal give konkrete, detaljerede oplysninger om, hvordan enheden bruges. Begynd med grundlæggende forberedelse til brug af enheden, såsom at tilslutte netledningen eller vaske dine hænder. Fortsæt med logiske, nummererede trin, der beskriver, hvordan du bruger enheden, samt enhver feedback (for eksempel "Du vil høre et klik ..."), som brugeren kan forvente, når han bruger enheden korrekt.
   • I slutningen af ​​dette kapitel skal brugere henvises til kapitlet til fejlfinding for at løse problemer, der ikke kan forklares hurtigt.
   • Placer billeder, hvor det er nødvendigt. Nogle trin forklares bedst med både billeder og ord. Overvej brugen af ​​fotos eller illustrationer i din manual.
   • I dette afsnit, som i ethvert afsnit, skal du medtage relevante sikkerhedsadvarsler om forkert brug eller betjening. For eksempel kan du advare brugere af motorsaven om ikke at drikke alkohol eller bruge motorsaven, mens de bruger visse lægemidler.
   • Hvis du tror, ​​at brugerne vil have gavn af det, kan du overveje at inkludere links til onlinevideoer, der viser korrekt brug og drift af enheden. Du kan optage disse videoer enten i begyndelsen af ​​dette afsnit eller (i tilfælde af videoer, der kun illustrerer et trin) i slutningen af ​​hvert trin.
6. Inkluder et resumé af produktet i slutningen. Resumeet skal vises i slutningen af ​​manualen lige før indekset for at give grundlæggende betjeningstrin. Dette skal være en forenklet, afskåret version af den operationelle information og bør ikke være mere end en side. Opsummer, hvordan enheden eller produktet skal bruges. Inkluder grundlæggende alarmer, nummererede trin, der forklarer, hvordan du bruger produktet, og telefonnumre eller e-mail-adresser, der henviser brugere til at hjælpe.
   • Hvis du forventer, at brugeren ofte fjerner eller henviser til oversigtsarket, kan du udskrive det på et aftageligt lamineret kort eller tykt pap for at gøre det lettere for brugeren at bære og henvise til.
   • Alternativt kan du anvende et resumé direkte på produktet til hurtig og nem reference for brugeren.

Del 3 af 4: Beskrivelse af produktvedligeholdelse

1. Forklar, hvordan enheden rengøres. Hvis din enhed eller dit produkt skal rengøres, skal du forklare, hvordan du gør dette. Angiv de nødvendige rengøringsmidler. Fortæl læseren, hvor ofte den skal rengøres. Så som i enhver anden del af manualen skal du inkludere nummererede trinvise instruktioner om, hvordan du rengør den.
   • Hvis rengøring kræver, at produktet skilles ad eller en bestemt del eller dele fjernes, skal du angive, hvordan produktet skal skilles ad.
   • Giv en advarsel om resultaterne af manglende rengøring af enheden. For eksempel kan du sige, "Hvis enheden ikke rengøres, vil ydelsen være mindre end optimal."
2. Tæl brugeren, hvordan man udfører grundlæggende vedligeholdelse. Hvis produktet eller enheden kan serviceres af brugeren for at rette problemer med ydeevnen, skal du angive nummererede instruktioner om, hvordan du gør dette for brugeren. For eksempel, hvis batterierne skal udskiftes efter hver 300 timers brug, skal du give instruktioner om, hvordan du kontrollerer, om batterierne skal udskiftes, hvordan du fjerner de døde batterier, og hvordan du installerer de nye.
   • Hvis der er visse vedligeholdelsesopgaver, der kun kan udføres af en certificeret tekniker, skal du dele vedligeholdelsesdelen af ​​manualen i to dele.
3. Diskuter opbevaringsmuligheder. Om nødvendigt bør manualen forklare, hvordan produktet eller enheden opbevares korrekt. Du skal også medtage oplysninger om, hvorfor opbevaring er nødvendig, og konsekvenserne af forkert opbevaring. For eksempel: du kunne skrive:
   • Opbevar produktet et køligt, tørt sted. Forkert opbevaring kan forkorte produktets levetid på grund af fugtopbygning. "
   • "Udsæt ikke produktet for varme eller opbevar det ved temperaturer over 50 grader Celsius.Hvis du gør det, kan det føre til forbrænding. "
4. Giv 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.
   • For eksempel, hvis der 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å medtage et telefonnummer og / eller e-mail til kundeservice i dette afsnit.

Del 4 af 4: Skriv en læsbar manual

1. Læs andre brugervejledninger. Inden du skriver en manual til dit eget produkt, skal du tjekke andre effektive brugervejledninger. Vær opmærksom på strukturen, ordvalg og sætningsstruktur. Store mærker som Apple, Google og Microsoft producerer stærke, effektive brugervejledninger, der kan hjælpe dig med at producere en mere omhyggeligt skrevet brugervejledning.
   • Læs ikke bare alle brugervejledninger. Læs manualerne for lignende produkter, du sælger. For eksempel, hvis du sælger babyprodukter, skal du læse babymanualer, ikke tekniske.
2. Vælg dine standarder. Standardisering af stavning, ordvalg og ordlyd gør brugervejledningen mere brugervenlig. Chicago Manual of Style og Microsoft Manual of Style kan også være nyttige stilguider, når du skriver din brugervejledning. Kontroller 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 dig til det.
3. Brug den aktive stemme. Den aktive stemme er en måde at skrive på, der forklarer ting fra brugerens perspektiv. Det er lettere at forstå end alternativet, den passive stemme, hvor motivet er udefineret.
   • Prøv Hemingway-appen (www.hemmingwayapp.com) for at identificere passive passager i din skrivning.
   • Undersøg disse to sætninger - den første er aktiv og den anden er passiv:
     • Du skal åbne pakken langsomt og forsigtigt.
     • Pakken skal åbnes langsomt og forsigtigt.
4. Skriv nummererede instruktioner. Numerisk bestilte instruktioner hjælper læseren med at fokusere bedre på processen med at bruge, tilslutte eller opbygge det pågældende produkt. I stedet for at skrive et langt, detaljeret afsnit eller en række ikke-nummererede afsnit, skal du skrive din brugervejledning med enkle, eksplicitte trin, hver tydeligt nummereret.
5. Begynd hvert trin med et imperativ. En bydende er et handlingsorienteret verbum. Ved at starte hvert trin med et verbum giver du læseren et tip om den handling, der kræves for at gennemføre trinnet. Afhængigt af det produkt, du skriver om, kan du f.eks. Starte dine trin med en kommando som "Connect", "Confirm" eller "Slide". Start dog ikke dine trin med et svar fra systemet.
   • For eksempel, hvis skærmen bliver blå og begynder at blinke, skal du ikke starte trinnet med: "Skærmen blinker og bliver blå." Prøv: "Tryk på og hold starttasten nede. Skærmen blinker og bliver blå. "
6. Bestem hvilket ordforråd du vil bruge. Hvis du skriver en yo-yo-manual, vil dit publikum for det meste være små børn. Brug enkle ord og ordforråd til at forklare, hvordan jojo fungerer. Når du skriver en scanningselektronmikroskopmanual, består dit publikum af højt kvalificerede forskere, der kan forstå meget detaljerede oplysninger, så vær ikke bange for at bruge specialiseret ordforråd eller nuancerede forklaringer.
   • Generelt forsøger du at undgå jargon og teknisk sprog.
   • For at være effektiv for den bredest mulige brugerbase, prøv at skrive på et niveau fra sjette til syvende klasse i grundskolen.
7. Når du sender et produkt til udlandet, skal du sørge for, at dine oversættelser er korrekte. Ansæt en oversætter til at oversætte din brugervejledning til det modersmål, det land du sender dit produkt til. Du kan også bruge et online oversættelsesprogram, men bed en indfødt taler om at læse oversættelsen og kontrollere for fejl.
   • Hvis flere sproggrupper er repræsenteret i dit publikum, bedes du medtage oversættelser af brugervejledningen på hvert relevant sprog.
   • Oversætteren skal være fortrolig med produktet, da der kan være forskellige ord på målsproget for specifikke termer, der ikke er ord-for-ord-oversættelser.
8. Skriv i korte sætninger. I stedet for et par lange afsnit bruger du mange korte afsnit. Se efter logiske pauser i hvert afsnit, og fordøj nyttige oplysninger i klumper med en eller to sætninger. Det samme gælder på sætningsniveau. Hold dine sætninger korte og enkle, snarere end lange og detaljerede.
   • Hvis et trin bliver for langt, skal du nedbryde det i mindre trin. Dette reducerer ikke antallet af ord, men linjeskiftene gør det lettere at læse.
9. Tjek manualen for fejl. En manual kan miste troværdighed på grund af grammatik og stavefejl. Få også en kollega eller teknisk forfatter til at redigere og korrekturlæse manualen. Ud over stavning og grammatik skal en korrekturlæser være opmærksom på følgende:
   • Passiv stemme
   • Uklart eller forvirrende sprog
   • Indpakket sætningsstruktur
   • Alt for lange afsnit

Tips

• Folk lærer på forskellige måder; Hvis det er muligt og hensigtsmæssigt, skal du medtage visuelle hjælpemidler eller links til onlinevideoer i vejledningen for at rumme visuelt orienterede læsere.