Gratis trinnvis instruksjoner 
Hvis du har et produkt som kan utføre mange forskjellige oppgaver eller deloppgaver, må du kjøre en oppgaveanalyse for hver oppgave. For eksempel: i en bil kan du tute på hornet, spenne deg fast og slå frontlyktene på eller av. Lag en jobbanalyse for hver av disse, om nødvendig. 
For at et produkts brukerhåndbok skal være effektiv, må den være skrevet i samsvar med etikettene som er festet direkte på produktet. Før du skriver brukerhåndboken, sørg for at enheten din har offisielle lisenser for salg. 
En annen måte å strømlinjeforme håndboken på er å bruke to kolonner, en til høyre med tekst og den andre like til venstre for teksten, med kuler, tall eller små ikoner, for eksempel advarselsskilt eller røde utropstegn. Håndboken kan hovedsakelig bestå av bilder med litt tekst under hvert bilde for å forklare enheten, eller den kan hovedsakelig være tekst med bare noen få tilhørende 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 ulike oppsett i en manual. Velg en og hold deg til den. 
For eksempel kan en generell advarsel for et elektrisk apparat være å ikke bruke det under regn. En spesifikk pekepinn kan være å sørge for at både hendene og enheten er tørre før du kobler til enheten. Gi bilder (som en hodeskalle og korsben) eller tekst i en annen farge (som rød tekst) for å skille advarselen fra resten av instruksjonene i håndboken og trekke brukernes oppmerksomhet til den. 
En deleliste Utpakkingsinstruksjoner Installasjonsadvarsler Konsekvenser av feil installasjon Hvem du skal ringe ved installasjonsvansker 
På slutten av dette kapittelet bør brukere henvises til feilsøkingskapittelet for å løse problemer som ikke kan forklares raskt. Legg ut bilder der det trengs. Noen trinn forklares best med både bilder og ord. Tenk på å bruke bilder eller illustrasjoner i håndboken. I denne delen, som i enhver del, bør du inkludere relevante sikkerhetsadvarsler om feil bruk eller bruk. Du kan for eksempel advare motorsagbrukere om ikke å drikke alkohol eller bruke motorsagen mens de tar visse medisiner. Hvis du tror det vil være til nytte for brukerne, bør du vurdere å inkludere lenker til nettvideoer som viser riktig bruk og drift av enheten. Du kan inkludere disse videoene enten i begynnelsen av denne delen, eller (når det er videoer som bare illustrerer ett trinn) på slutten av hvert trinn. 
Hvis du forventer at brukeren skal fjerne sammendragsarket eller trenger å referere til det ofte, kan du skrive det ut på et avtagbart laminert kort eller tykk papp for å gjøre det lettere for brukeren å bære og referere til. Alternativt kan du legge et sammendrag direkte på produktet for rask og enkel referanse for brukeren. 
Hvis det er visse vedlikeholdsoppgaver som kun kan utføres av en sertifisert tekniker, del vedlikeholdsdelen av håndboken i to deler. 
`Oppbevar produktet på et kjølig, tørt sted. Feil oppbevaring kan forkorte produktets levetid på grunn av fuktighet.` `Ikke utsett produktet for varme og ikke oppbevar det ved temperaturer over 50 grader Celsius. Hvis du gjør dette, kan det føre til antennelse.` 
For eksempel, hvis det er flere problemer med datamaskinen som viser en blå skjerm, grupperer du dem under en underoverskrift, for eksempel "Vanlige skjermproblemer". Du må også inkludere et kundeservicenummer og/eller e-post i denne delen. 
For eksempel, i stedet for å bruke både "på/av-bryter" og "på/av-knapp" i håndboken, velg ett av de to uttrykkene og hold deg til det. 
Prøv Hemingway-appen (www.hemmingwayapp.com) for å gjenkjenne passive passasjer i skrivingen din. Studer disse to eksempelsetningene -- den første er aktiv og den andre passiv: Du må åpne pakken sakte og forsiktig. Pakken må åpnes sakte og forsiktig. 
For eksempel, hvis skjermen blir blå og begynner å blinke, ikke start trinnet med "Skjermen vil blinke og bli blå.` Prøv: `Trykk og hold nede hjemtasten. Skjermen vil blinke og bli blå.` 
Prøv generelt å unngå sjargong og fagspråk. For å være effektiv for en bredest mulig brukerbase, prøv å skrive på et nivå fra sjette til sjuende klasse. 
Hvis flere språkgrupper er representert i publikummet ditt, vennligst ta med oversettelser av brukerhåndboken på hvert relevant språk. Oversetteren bør være kjent med produktet siden det kan være andre ord på målspråket for spesifikke termer som ikke er ord-for-ord-oversettelser. 
Hvis et trinn begynner å bli for langt, del det ned i mindre trinn. Dette vil ikke redusere antall ord, men linjeskiftene vil gjøre det lettere å lese. 
Passiv stemme Uklart eller forvirrende språk innpakket setningsstruktur For lange avsnitt
Skrive en brukerveiledning
Innhold
Programvare, datamaskiner, spill og enheter krever brukermanualer; guider som forklarer hvordan du bruker produktet (og hvordan du ikke gjør det). En brukermanual er et formelt dokument med en bestemt struktur, og bør skrives av noen som kjenner produktet gjennom og gjennom, for eksempel en teknisk skribent eller produktdesigneren. Å skrive en effektiv brukermanual krever at du vet hvem som skal bruke produktet, og at du skriver manualen med disse brukerne i tankene. Hold skrivingen din klar, presis og enkel for å sikre en problemfri brukeropplevelse.
Trinn
Del 1 av 4: Planlegging av brukerveiledningen
1. Gjør en brukeranalyse. Brukerveiledningen bør være skrevet for brukerne - de som skal kjøpe produktet eller tjenesten og lese brukerveiledningen. En brukeranalyse vil fortelle deg hvem din hoved- eller målgruppe vil være og veilede deg i å skrive teksten.
- Snakk med folk som skal bruke enheten din. Gi testbrukere prototyper av enheten og et utkast til brukerhåndboken under kontrollerte forhold. Be disse testbrukerne om tilbakemelding på ting som ikke er tydelige eller forvirrende i brukerveiledningen, og gjør endringer i brukerveiledningen din basert på denne tilbakemeldingen.
- Du kan aldri glede hele publikummet ditt; skrive manualen tilpasset målgruppen eller den største målgruppen.
- Tenk på alder, helse (har de noen sykdommer, lærevansker eller funksjonshemninger?) og utdanningsnivået til publikum, for å bestemme den beste tilnærmingen for å skrive brukerhåndboken.
2. Koordinere utformingen av brukermanualen. Hvis du var en del av teamet som hjalp til med å designe og utvikle enheten eller produktet, kan det være vanskelig å objektivt se på produktet for å forklare hvordan det fungerer. Du bør derfor søke råd fra en skribent (helst noen med erfaring med å skrive instruksjoner) og en grafisk designer for å hjelpe deg med å utarbeide brukermanualen. Du kan velge disse personene gjennom en ekstern konsulentvirksomhet eller fra din egen bedrift eller organisasjon.
3. Gjør en jobbanalyse. En 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 handlingene, feilene og feilsøkingsrådene hvert trinn kan kreve.
4. Sørg for at produktet ditt oppfyller kravene til merking og markedsføringstillatelse. Disse kravene sikrer at produktene produseres med brukerens sikkerhet i tankene, og at brukerens eksponering for farlige forhold, som stråling og elektrosjokk, er begrenset. Annonser bør tydelig angi formålet og grunnleggende driftsretningslinjer for et produkt, og du bør bruke disse ressursene når du skriver brukerveiledningen din.
5. Bestem utformingen av manualen din. Det er flere viktige måter du kan strømlinjeforme håndboken på. Du må sette en fet overskrift i begynnelsen av hvert avsnitt med hvert ord med store bokstaver. For eksempel kan «Konfigurer enheten din», «Kontroller enheten din» og «Feilsøking» alle være fete seksjonsoverskrifter.
Del 2 av 4: Innbygging av viktig informasjon
1. Organiser manualen logisk. Håndboken bør være bygget opp på en slik måte at brukeren får mest mulig utbytte av den. Del manualen inn i kapitler eller seksjoner som er fornuftige for bruk av produktet, og ta med en innholdsfortegnelse foran i manualen slik at hver del kan bli funnet raskt.
- En innholdsfortegnelse er spesielt nødvendig for lengre veiledninger.
- En ordliste eller indeks er nødvendig hvis det er mange begreper for å forklare som publikum kanskje ikke vet. En ordliste anbefales imidlertid ikke; det beste valget er å forklare forvirrende termer i teksten i selve håndboken. Hvis du velger å inkludere en ordliste, plasser den foran i manualen, like etter innholdsfortegnelsen.
- En liste over tabeller eller figurer er kun nødvendig hvis det er flere 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 manualen, da det vil forstyrre flyt og fokus.
2. Inkluder nødvendige advarsler. De generelle advarslene eller forsiktighetsinformasjonen bør gi informasjon om potensielle farer som kan oppstå ved feil bruk av produktet, inkludert død eller alvorlig skade. 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.
3. Beskriv enheten. Beskrivelsen din bør inneholde både en skriftlig forklaring av formålet med enheten og en liten grafisk representasjon av hvordan enheten ser ut. Illustrasjonen skal merke og navngi alle brytere, knapper og deler som kan festes i enheten.
4. Gi installasjonsinstruksjoner. Installasjonsdelen bør inneholde grunnleggende informasjon om hvordan du forbereder deg på å bruke produktet eller enheten. Hvis enheten ikke kan bygges eller settes opp av en hjemmebruker, oppgi dette tydelig i en fet overskrift øverst i installasjonsdelen. Du bør også inkludere følgende:
5. Oppgi driftsinformasjon. Denne delen er den viktigste delen av brukerhåndboken og skal gi konkret, detaljert informasjon om hvordan du bruker enheten. Begynn med den grunnleggende forberedelsen før du bruker apparatet, for eksempel å sette i støpselet eller vaske hendene. Fortsett med logiske, nummererte trinn som beskriver hvordan du bruker enheten, samt tilbakemelding (for eksempel "Du hører et klikk...`) som brukeren kan forvente ved riktig bruk av enheten.
6. Legg til et sammendrag av produktet på slutten. Sammendraget bør komme på slutten av håndboken, like før indeksen, for å gi de grunnleggende operasjonstrinnene. Dette bør være en forenklet, nedstrippet versjon av driftsinformasjonen, og bør ikke overstige én side. Oppsummer hvordan du bruker enheten eller produktet. Inkluder grunnleggende advarsler, nummererte trinn som forklarer hvordan du bruker produktet, og telefonnumre eller e-postadresser som leder brukerne til å hjelpe.
Del 3 av 4: Beskriver produktvedlikeholdet
1. Forklar hvordan du rengjør enheten. Hvis enheten eller produktet må rengjøres, forklar hvordan du gjør det. Liste over nødvendige rengjøringsmidler. Fortell leseren hvor ofte den skal rengjøre. Deretter, som i alle andre deler av håndboken, inkluderer nummererte trinnvise instruksjoner om hvordan du rengjør.
- Hvis rengjøring krever demontering av produktet, eller fjerning av en bestemt del eller deler, vennligst angi hvordan produktet skal demonteres.
- Gi en advarsel om resultatene av manglende rengjøring av enheten. For eksempel kan du si: "Hvis enheten ikke blir rengjort, vil ytelsen være mindre enn optimal.`
2. Tell brukeren hvordan grunnleggende vedlikehold skal utføres. Hvis produktet eller enheten kan betjenes av brukeren for å korrigere ytelsesproblemer, gi nummererte instruksjoner om hvordan dette gjøres av brukeren. For eksempel: hvis batteriene må skiftes ut etter hver 300. driftstime, gi instruksjoner om hvordan du sjekker om batteriene må skiftes, hvordan du tar ut de brukte batteriene og hvordan du setter inn de nye batteriene.
3. Diskuter lagringsalternativer. Håndboken skal om nødvendig forklare hvordan produktet eller enheten skal oppbevares på riktig måte. Du bør også inkludere informasjon om hvorfor oppbevaring er nødvendig, og hva konsekvensene er av feiloppbevaring. Du kan for eksempel skrive:
4. Oppgi feilsøkingsinformasjon. Du kan organisere denne delen som en liste over vanlige problemer og deres løsninger. Grupper lignende problemer under en logisk overskrift. På denne måten kan brukere raskt finne spesifikke problemer.
Del 4 av 4: Skrive en lesbar veiledning
1. Les andre brukerveiledninger. Før du skriver en manual for ditt eget produkt, se på andre effektive brukermanualer. Vær oppmerksom på struktur, ordvalg og setningsoppbygging. Store merker som Apple, Google og Microsoft produserer sterke, effektive brukerveiledninger som kan hjelpe deg med å lage en gjennomtenkt skrevet brukerveiledning.
- Ikke bare les alle brukermanualer. Les manualene til lignende produkter du selger. For eksempel: hvis du selger babyprodukter, les babymanualer, ikke tekniske.
2. Velg dine standarder. Standardisering av rettskrivning, ordvalg og formulering vil gjøre brukerveiledningen mer brukervennlig. Chicago Manual of Style og Microsoft Manual of Style kan også være nyttige stilguider når du skriver brukerhåndboken; sjekk begge for å se om den ene er riktig for bruksanvisningen din.
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 subjektet er udefinert.
4. Skriv nummererte instruksjoner. Numerisk ordnede instruksjoner hjelper leseren bedre å fokusere 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 brukerveiledningen med enkle, eksplisitte trinn, hver tydelig nummerert.
5. Begynn hvert trinn med et imperativ. Et 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. For eksempel, avhengig av produktet du skriver om, kan du starte trinnene dine med en kommando som «Koble til», «Bekreft» eller «Skyv». Ikke start trinnene dine med et svar fra systemet.
6. Bestem hvilket ordforråd du vil bruke. Hvis du skriver en brukermanual for en jojo, vil publikum i hovedsak bestå av små barn. Bruk enkle ord og vokabular for å forklare hvordan jojoen fungerer. Når du skriver en manual for et skanningselektronmikroskop, består publikum av høyt trente forskere som kan forstå svært detaljert informasjon, så ikke viker unna å bruke spesialisert vokabular eller nyanserte forklaringer.
7. Når du sender et produkt til utlandet, sørg for at oversettelsene dine er nøyaktige. Lei en oversetter for å oversette brukerhåndboken til morsmålet i landet du sender produktet til. Du kan også bruke et oversettelsesverktøy på nett, men be en som har morsmål om å lese oversettelsen og se etter feil.
8. Skriv i korte setninger. I stedet for noen få lange avsnitt, bruk mange korte avsnitt. Se etter logiske brudd i hver seksjon og fordøy nyttig informasjon i biter med én eller to setninger. Det samme gjelder på setningsnivå. Hold setningene dine korte og enkle, i stedet for lange og detaljerte.
9. Sjekk bruksanvisningen for feil. En manual kan miste troverdighet på grunn av grammatikk- og stavefeil. La en kollega eller teknisk skribent også redigere og korrekturlese manualen. I tillegg til rettskriving og grammatikk, bør en korrekturleser være oppmerksom på følgende:
Tips
- Folk lærer på forskjellige måter; Hvis mulig og hensiktsmessig, inkludere visuelle hjelpemidler eller lenker til nettvideoer i håndboken for å imøtekomme visuelt orienterte lesere.
Artikler om emnet "Skrive en brukerveiledning"
Оцените, пожалуйста статью
Populær
