Innhold

• Å trå
• Del 1 av 4: Planlegge brukerhåndboken
• Del 2 av 4: Legge inn viktig informasjon
• Del 3 av 4: Beskrive produktvedlikehold
• Del 4 av 4: Skriv en lesbar manual
• Tips

Programvare, datamaskiner, spill og enheter krever brukerhåndbøker; guider som forklarer hvordan du bruker produktet (og hvordan ikke). En brukerhåndbok er et formelt dokument med en spesifikk struktur og må skrives av noen som kjenner produktet innvendig og utvendig, for eksempel en teknisk forfatter eller produktdesigneren. Å skrive en effektiv brukerhåndbok krever at du vet hvem som vil bruke produktet, og at du skriver manualen med tanke på disse brukerne. Hold skrivingen tydelig, presis og enkel for å sikre en problemfri brukeropplevelse.

Å trå

Del 1 av 4: Planlegge brukerhåndboken

1. Gjør en brukeranalyse. Brukerhåndboken skal skrives for brukerne - de som vil kjøpe produktet eller tjenesten din og lese bruksanvisningen. En brukeranalyse vil fortelle deg hvem din hoved- eller målgruppe vil være, og vil lede deg gjennom skrivingen av teksten.
   • Snakk med folk som skal bruke enheten din. Tilby testbrukere prototyper av enheten og utkast til brukerhåndbok under kontrollerte forhold. Be disse testbrukerne om tilbakemelding på ting som er uklare eller forvirrende i brukerhåndboken, og gjør endringer i brukerhåndboken din basert på denne tilbakemeldingen.
   • Du kan aldri tilfredsstille hele publikum; skriv håndboken tilpasset målgruppen eller det største publikummet.
   • Tenk på alder, helse (har de noen sykdommer, lærevansker eller funksjonshemninger?) Og utdanningsnivået til publikum for å bestemme den beste tilnærmingen til å skrive brukerhåndboken.
2. Koordinere utformingen av brukerhåndboken. Hvis du var en del av teamet som hjalp med å designe og utvikle enheten eller produktet, kan det være vanskelig å ta et objektivt blikk på produktet for å forklare hvordan det fungerer. Du bør derfor søke råd fra en forfatter (helst noen med erfaring med å skrive instruksjoner) og en grafisk designer for å hjelpe deg med å forberede brukerhåndboken. Du kan velge disse menneskene gjennom et eksternt konsulentselskap eller fra din egen bedrift eller organisasjon.
3. Gjør en oppgaveanalyse. Jobbanalyse er prosessen med å identifisere og organisere trinnene som kreves for å bruke enheten. En grundig jobbanalyse identifiserer materialene og utstyret (som batterier, medisiner eller andre brukerleverte produkter) som kreves for hvert trinn, samt handlinger, feil og feilsøkingsråd som hvert trinn kan kreve.
   • Hvis du har et produkt som kan utføre mange forskjellige oppgaver eller deloppgaver, må du utføre en oppgaveanalyse for hver oppgave. For eksempel: i en bil kan du tute, feste deg inn og skru frontlyktene på eller av. Gjør en jobbanalyse for hver av disse, om nødvendig.
4. Forsikre deg om at produktet ditt oppfyller kravene til merking og markedsføringstillatelse. Disse kravene sikrer at produktene produseres med tanke på brukerens sikkerhet, og at brukerens eksponering for farlige forhold, som stråling og elektrisitet, er begrenset. Annonser skal tydelig angi formålet med og grunnleggende retningslinjer for et produkt, og du bør bruke disse ressursene når du skriver brukerhåndboken.
   • For at et produkts brukerhåndbok skal være effektiv, må den skrives i samsvar med etikettene som er festet direkte på produktet.
   • Forsikre deg om at enheten din er offisielt lisensiert for salg før du skriver brukerhåndboken.
5. Bestem deg for utformingen av håndboken din. Det er flere viktige måter du kan strømlinjeforme håndboken din. Du må sette en fet overskrift i begynnelsen av hver seksjon med hvert ord med store bokstaver. For eksempel kan "Konfigurere enheten", "Betjene enheten" og "Feilsøke" alle være fete seksjonsoverskrifter.
   • En annen måte å effektivisere guiden din er å bruke to kolonner, den ene til høyre med tekst og den andre bare til venstre for teksten, med kuler, tall eller små ikoner, for eksempel advarselsmerker eller røde utropstegn.
   • Håndboken kan hovedsakelig bestå av bilder med litt tekst under hvert bilde for å forklare enheten, eller det kan hovedsakelig være tekst med bare noen få medfølgende bilder. Du kan også bruke et flytskjema for å veilede brukeren. Tenk på produktet ditt og hvordan hver metode kan hjelpe deg med å skrive håndboken. Unngå imidlertid å blande forskjellige oppsett i en manual. Velg en og hold deg til den.

Del 2 av 4: Legge inn viktig informasjon

1. Organiser håndboken logisk. Håndboken skal være strukturert på en slik måte at brukeren får mest mulig utbytte av den. Del håndboken i kapitler eller seksjoner som er fornuftige for bruk av produktet, og inkluder en innholdsfortegnelse foran på manualen, slik at hvert avsnitt raskt kan bli funnet.
   • Innholdsfortegnelse er spesielt nødvendig for lengre manualer.
   • Det er nødvendig med en ordliste eller indeks hvis det er mange begreper som forklarer at publikum kanskje ikke er kjent med. Imidlertid anbefales ikke en ordliste; det beste valget er å forklare forvirrende ord i selve manualen. Hvis du velger å ta med en ordliste, plasserer du den foran i manualen, rett etter innholdsfortegnelsen.
   • En liste over tabeller eller figurer er bare nødvendig hvis det er mer enn noen få tabeller eller figurer i håndboken.
   • Et vedlegg er nødvendig for ting som må forklares, men som ikke kan forklares andre steder i håndboken, da det ville forstyrre flyt og fokus.
2. Inkluder nødvendige advarsler. Generelle advarsler eller forholdsregler bør gi informasjon om potensielle farer forårsaket av feil bruk av produktet, inkludert død eller alvorlig personskade. Disse advarslene bør plasseres helt foran i manualen, etter forsiden, slik at brukeren ser dem først. Spesifikke advarsler bør også inkluderes i teksten i håndboken like etter eller like før et potensielt farlig trinn foreslås.
   • For eksempel kan en generell advarsel for et elektrisk apparat være å ikke bruke det når det regner.
   • En spesifikk instruksjon kan være å sørge for at både hendene og enheten er tørre før du kobler enheten til strømuttaket.
   • Gi bilder (for eksempel hodeskalle og tverrbein) eller tekst i en annen farge (for eksempel rød tekst) for å skille advarselen fra resten av retningen i bruksanvisningen og gjøre brukerne oppmerksomme på den.
3. Beskriv enheten. Beskrivelsen din skal inneholde både en skriftlig forklaring av formålet med enheten og en liten grafisk fremstilling av hvordan enheten ser ut. Figuren skal merke og gi navn til alle brytere, knapper og deler som kan festes i enheten.
4. Gi installasjonsinstruksjoner. Installasjonsdelen skal inneholde grunnleggende informasjon om hvordan du forbereder deg på å bruke produktet eller enheten. Hvis apparatet ikke kan bygges eller settes opp av en hjemmebruker, må du tydelig si dette med en fet overskrift øverst i installasjonsdelen. Du bør også inkludere følgende:
   • En deleliste
   • Instruksjoner for utpakking
   • Installasjonsadvarsler
   • Konsekvenser av feil installasjon
   • Hvem skal du ringe i tilfelle problemer under installasjonen
5. Gi informasjon om operasjonen. Denne delen er den viktigste delen av brukerhåndboken og skal gi konkret, detaljert informasjon om hvordan du bruker enheten. Begynn med grunnleggende forberedelser for bruk av enheten, for eksempel å koble til strømledningen eller vaske hendene. Fortsett med logiske, nummererte trinn som beskriver hvordan du bruker enheten, samt tilbakemeldinger (for eksempel "Du vil høre et klikk ...") som brukeren kan forvente når du bruker enheten riktig.
   • På slutten av dette kapittelet bør brukere henvises til feilsøkingskapitlet for å løse problemer som ikke raskt kan forklares.
   • Plasser bilder der det er nødvendig. Noen trinn forklares best med både bilder og ord. Vurder bruken av bilder eller illustrasjoner i håndboken din.
   • I denne delen, som i alle seksjoner, bør du inkludere relevante sikkerhetsadvarsler om feil bruk eller bruk. For eksempel kan du advare motorsagbrukere om ikke å drikke alkohol eller bruke motorsagen mens de bruker visse medisiner.
   • Hvis du tror brukere vil ha fordeler, bør du vurdere å ta med lenker til onlinevideoer som viser riktig bruk og drift av enheten. Du kan ta opp disse videoene enten i begynnelsen av denne delen, eller (i tilfelle videoer som illustrerer bare ett trinn) på slutten av hvert trinn.
6. Inkluder et sammendrag av produktet på slutten. Sammendraget skal vises på slutten av manualen, rett før indeksen, for å gi grunnleggende trinn. Dette bør være en forenklet, avklistret versjon av driftsinformasjonen, og bør ikke være mer enn en side. Oppsummer hvordan enheten eller produktet skal brukes. Inkluder grunnleggende varsler, nummererte trinn som forklarer hvordan du bruker produktet, og telefonnumre eller e-postadresser som henviser brukere til å hjelpe.
   • Hvis du forventer at brukeren fjerner eller refererer til sammendragsarket ofte, kan du skrive det ut på et avtakbart laminert kort eller tykt papp for å gjøre det lettere for brukeren å bære og referere til.
   • Alternativt kan du bruke et sammendrag direkte på produktet for rask og enkel referanse for brukeren.

Del 3 av 4: Beskrive produktvedlikehold

1. Forklar hvordan du rengjør enheten. Hvis enheten eller produktet trenger rengjøring, forklar du hvordan du gjør dette. Oppgi nødvendige rengjøringsmidler. Fortell leseren hvor ofte den skal rengjøres. Så, som i alle andre deler av håndboken, inkluderer du nummererte trinnvise instruksjoner om hvordan du rengjør den.
   • Hvis rengjøring krever at produktet demonteres, eller at en bestemt del eller deler fjernes, angir du hvordan produktet skal demonteres.
   • Gi en advarsel om resultatene av feil på rengjøring av enheten. For eksempel kan du si: "Hvis enheten ikke blir renset, vil ytelsen være mindre enn optimal."
2. Telle brukeren hvordan man utfører grunnleggende vedlikehold. Hvis produktet eller enheten kan brukes av brukeren for å løse ytelsesproblemer, må du gi nummererte instruksjoner om hvordan du gjør dette for brukeren. For eksempel, hvis batteriene må byttes ut hver 300. driftstime, gir du instruksjoner om hvordan du sjekker om batteriene må byttes ut, hvordan du tar ut de døde batteriene og hvordan du installerer de nye.
   • Hvis det er visse vedlikeholdsoppgaver som bare kan utføres av en sertifisert tekniker, kan du dele vedlikeholdsdelen av håndboken i to deler.
3. Diskuter lagringsalternativer. Om nødvendig bør manualen forklare hvordan produktet eller enheten skal lagres riktig. Du bør også ta med informasjon om hvorfor lagring er nødvendig og konsekvensene av feil lagring. For eksempel: du kan skrive:
   • Oppbevar produktet på et kjølig, tørt sted. Feil lagring kan forkorte produktets levetid på grunn av fuktighet. "
   • "Ikke utsett produktet for varme eller oppbevar det ved temperaturer over 50 grader Celsius.Hvis du gjør det, kan det føre til forbrenning. "
4. Gi feilsøkingsinformasjon. Du kan organisere denne delen som en liste over vanlige problemer og deres løsninger. Gruppere lignende problemer under en logisk overskrift. På denne måten kan brukerne raskt finne spesifikke problemer.
   • Hvis det for eksempel er flere problemer med at datamaskinen viser en blå skjerm, grupperer du dem under en underoverskrift, for eksempel "Vanlige skjermproblemer".
   • Du må også inkludere et telefonnummer og / eller e-post for kundeservice i denne delen.

Del 4 av 4: Skriv en lesbar manual

1. Les andre brukerhåndbøker. Før du skriver en håndbok for ditt eget produkt, bør du sjekke ut andre effektive brukerhåndbøker. Ta hensyn til strukturen, ordvalget og setningsstrukturen. Store merkevarer som Apple, Google og Microsoft produserer sterke, effektive brukerhåndbøker som kan hjelpe deg med å produsere en mer gjennomtenkt skrevet brukerhåndbok.
   • Ikke bare les alle brukerhåndbøker. Les håndbøkene for lignende produkter du selger. For eksempel, hvis du selger babyprodukter, les babyhåndbøker, ikke tekniske.
2. Velg standarder. Standardisering av staving, ordvalg og ordlyd vil gjøre brukerhåndboken mer brukervennlig. Chicago Manual of Style og Microsoft Manual of Style kan også være nyttige stilveiledninger når du skriver brukerhåndboken. sjekk begge for å se om en er riktig for manualen din.
   • For eksempel, i stedet for å bruke både "strømbryter" og "av / på-knapp" i håndboken din, velg ett av de to begrepene og hold deg til det.
3. Bruk den aktive stemmen. Den aktive stemmen er en måte å skrive på som forklarer ting fra brukerens perspektiv. Det er lettere å forstå enn alternativet, den passive stemmen, der motivet er udefinert.
   • Prøv Hemingway-appen (www.hemmingwayapp.com) for å identifisere passive passasjer i skrivingen.
   • Studer disse to prøvesetningene - den første er aktiv og den andre er passiv:
     • Du må åpne pakken sakte og forsiktig.
     • Pakken skal åpnes sakte og forsiktig.
4. Skriv nummererte instruksjoner. Numerisk bestilte instruksjoner hjelper leseren til å fokusere bedre på prosessen med å bruke, koble til eller bygge det aktuelle produktet. I stedet for å skrive et langt, detaljert avsnitt eller en serie unummererte avsnitt, skriv brukerhåndboken din med enkle, eksplisitte trinn, hver tydelig nummerert.
5. Begynn hvert trinn med et imperativ. En imperativ er et handlingsorientert verb. Ved å starte hvert trinn med et verb, gir du leseren et hint om handlingen som kreves for å fullføre trinnet. Avhengig av for eksempel produktet du skriver om, kan du starte trinnene med en kommando som "Connect", "Confirm" eller "Slide". Men ikke start trinnene dine med et svar fra systemet.
   • Hvis for eksempel skjermen blir blå og begynner å blinke, ikke start trinnet med: "Skjermen vil blinke og bli blå." Prøv: "Trykk og hold nede starttasten. Skjermen blinker og blir blå. "
6. Bestem hvilket ordforråd du vil bruke. Hvis du skriver en jojo-manual, vil publikum for det meste være små barn. Bruk enkle ord og ordforråd for å forklare hvordan jojo fungerer. Når du skriver en skanningelektronmikroskopmanual, består publikummet av dyktige forskere som kan forstå veldig detaljert informasjon, så vær ikke redd for å bruke spesialisert ordforråd eller nyanserte forklaringer.
   • Generelt prøver du å unngå sjargong og fagspråk.
   • For å være effektiv for en bredest mulig brukerbase, prøv å skrive på et nivå fra sjette til syvende trinn på grunnskolen.
7. Når du sender et produkt til utlandet, må du sørge for at oversettelsene dine er nøyaktige. Ansett en oversetter for å oversette brukerhåndboken til morsmålet i landet du sender produktet til. Du kan også bruke et online oversettelsesprogram, men be en morsmål om å lese oversettelsen og se etter feil.
   • Hvis flere språkgrupper er representert i publikummet ditt, vennligst inkluder oversettelser av brukerhåndboken på hvert relevant språk.
   • Oversetteren må være kjent med produktet da det kan være forskjellige ord på målspråket for spesifikke termer som ikke er ord-for-ord-oversettelser.
8. Skriv i korte setninger. I stedet for noen få lange avsnitt bruker du mange korte avsnitt. Se etter logiske pauser i hver seksjon og fordøy nyttig informasjon i en- eller to-setningsbiter. Det samme gjelder setningsnivå. Hold setningene korte og enkle, i stedet for lange og ordrike.
   • Hvis et trinn blir for langt, kan du dele det opp i mindre trinn. Dette vil ikke redusere antall ord, men linjeskiftene vil gjøre det lettere å lese.
9. Sjekk manualen for feil. En manual kan miste troverdigheten på grunn av grammatikk og stavefeil. La en kollega eller teknisk forfatter også redigere og korrekturles håndboken. I tillegg til staving og grammatikk, bør en korrekturleser ta hensyn til følgende:
   • Passiv stemme
   • Uklart eller forvirrende språk
   • Innpakket setningsstruktur
   • Altfor lange avsnitt

Tips

• Folk lærer på forskjellige måter; Hvis det er mulig og hensiktsmessig, inkluder visuelle hjelpemidler eller lenker til onlinevideoer i håndboken for å imøtekomme visuelt orienterte lesere.