Innhold

• Steps
• Tips
• Nødvendige materialer

Brukerhåndbøker er skrevne guider - som kan gjøres tilgjengelig på trykk eller digitalt - som gir instruksjoner om hvordan du gjør noe eller bruker et produkt. Selv om uttrykket "brukerveiledning" er assosiert med programvarehåndbøker, følger brukerhåndbøker også datamaskiner og andre elektroniske enheter som TV-apparater, radioer, telefoner og mp3-spillere, i tillegg til husholdningsartikler og hageanlegg. En god håndbok lærer brukerne om produktets funksjoner mens de lærer dem å bruke dem effektivt, etter å ha forklart alt på en enkel måte. Nedenfor finner du ting du bør vurdere når du lager en bruksanvisning, fra innhold til layout.

Steps

Del 1 av 3: Opprette riktig brukerdokumentasjon

1. 

   
   
   Definer hvem brukeren skal være. For å skrive en god manual, må du utvikle profilen til målbrukeren, enten formelt - når du oppretter en skriftlig profil - eller uformelt - ved å ta deg tid til å identifisere egenskapene til sannsynlige brukere av produktet. Denne profilen er nyttig når du er en del av et team som skriver brukerdokumentasjon, samt hjelper deg å ta produktet fra konsept til endelig form. Når du danner en brukerprofil, bør du tenke på:
   • Hvor brukere vil bruke guiden, enten de er hjemme, på kontoret, i et isolert arbeidsmiljø eller i bilen. Dette kan ikke bare bestemme innholdet, men stilen på manualen.
   • Hvordan brukere vil bruke guiden. Hvis håndboken sjelden må konsulteres eller bare fungerer som en form for forskning, må den ha form av et referansedokument. Hvis det er noe brukerne ofte vil referere til fra begynnelsen, bør referansedelen ledsages av en "Komme i gang" -delingen og instruksjoner for de vanligste produktfunksjonene.
   • I opplevelsen som brukere allerede har med produktet og lignende. Hvis produktet ditt er nytt eller veldig forskjellig fra lignende konkurrenter, må du forklare forskjellene og ta med instruksjoner om hvordan du kommer i gang. Hvis produktet tar for seg noe som brukere vanligvis opplever problemer med, for eksempel noe dataprogramvare, må du gi tilstrekkelig informasjon og detaljere det på en forståelig måte.

2. 

   
   
   Skriv ned brukerens behov slik at han kan forstå deg. Med mindre brukeren har teknisk kunnskap, er det bedre å unngå teknisk språk, alltid velge enkle og tydelige forklaringer. Teksten må være organisert på en slik måte at den etterligner brukernes tenkning; Oppføringsalternativer gruppert etter funksjon gir mer mening enn å oppgi dem i henhold til bruksfrekvens, for eksempel.
   • Det er ofte ingen flukt fra tekniske termer, for eksempel når du skriver en manual for kartlegging av programvare som inkluderer Fibonacci-diagrammer sammen med andre mer vanlige diagrammer. I så fall er det nyttig å definere begrepene og gi noen type bakgrunn, som en forklaring på hva Fibonacci-diagrammer er og hva deres bruk er i økonomisk analyse.

3. 

   
   
   Forklar problemet som brukeren prøver å løse og presentere løsningen. Å tilby et alternativ som en løsning på det generelle problemet er noe som fungerer for å markedsføre produktet, men etter kjøpet vil brukeren måtte lære seg å bruke produktet i bruk. Identifiser spesifikke problemer som personen vil møte, forklar dem i håndboken, og avslutt med instruksjonene for å løse dem.
   • Hvis problemet er sammensatt, kan du dele det opp i mindre deler. Liste instruksjonene og løsningene i rekkefølge. Å dele informasjon på denne måten er en metode kjent som "fragmentering".

Del 2 av 3: Forstå komponentene i en bruksanvisning

1. 

   Ta med forsiden og tittelsidene. Du trenger et deksel til andre manualer enn et enkelt referansekort og en tittelside for enhver manual som er mer enn et brettet papirark.
   • Hvis håndboken er beskyttet av opphavsrett, må varselet settes inn på forsiden og på tittelsidene.
   • Hvis det er vilkår og betingelser for bruk av manualen og produktet tilknyttet den, plasserer du dem på innsiden av dekselet.

2. 

   Plasser referanser til relaterte dokumenter i forordet. Hvis dokumentasjonen ikke bare er manualen, kan du referere til dokumentene som har gjeldende versjoner her. Du vil også sette inn delen "Hvordan bruke denne guiden", hvis noen, i forordet.

3. 

   Inkluder en indeks hvis håndboken har mer enn 10 sider.

4. 

   Plasser instruksjoner / prosedyrer og referansemateriell i boken til manualen. I de fleste tilfeller bør disse elementene ha sine egne seksjoner, men det er mulig å instruere leseren om å konsultere spesifikt innhold fra en seksjon til en annen. På denne måten er brukeren i stand til å finne den ønskede informasjonen raskere.
   • Prosedyrene må skrives med en jevn struktur i instruksjonsdelen i håndboken. Begynn med en oversikt over oppgaven og beskriv deretter hva brukeren skal gjøre og hvilket resultat som skal oppnås. Trinnene må være nummerert og begynne med handlingsverb, samt trinnene i delene av denne artikkelen.
   • Referansemateriell kan inneholde lister med alternativer, tips om feilsøking og ofte stilte spørsmål. Ordliste og indekser kan også legges til på slutten av manualen, selv om listen over ofte brukte termer vanligvis vises i begynnelsen. Indeksen kan utelates hvis manualen har mindre enn 20 ark.

5. 

   Bruk om nødvendig bilder. Bildene kan illustrere noen ideer bedre enn tekstene, spesielt når de beskriver komplekse prosedyrer der brukeren trenger visuell informasjon for å bekrefte at han utfører trinnene riktig. Bildene kan produseres med tegneprogramvare, digitale kameraer og programvare for bilderedigering (som også kan brukes i tilfeller av skjermdumping).
   • Når du har laget bildet, kan du lagre det i et komprimert format som blir akseptert av programvaren der du diagrammer manualen. Reduser også den fysiske størrelsen på den slik at den passer til størrelsen på sidene, men uten å eliminere de nødvendige detaljene for brukeren. Om nødvendig kan du dele bildet i deler for å vise de aktuelle delene ved siden av teksten.
   • Hvis du bruker flere bilder, kan du standardisere størrelsen, enten bruke samme lengde og bredde eller redusere dem proporsjonalt i forhold til den opprinnelige størrelsen. Dette vil gjøre dem mer attraktive for leseren. Det samme gjelder å lage skjermbilder av en datamaskin, der det er nødvendig å standardisere fargeskjemaet til systemet slik at de alle ser like ut.
   • Selv om redigeringsprogramvare, for eksempel Photoshop og Paint Shop Pro, tilbyr anstendig skjermbildefunksjonalitet, har dedikert programvare, for eksempel Snaglt, også muligheter for å enkelt endre, katalogisere og sette inn kommentarer i bilder.

Del 3 av 3: Designing a Readable Manual

1. 

   Velg lesbare skrifter. Selv om datamaskiner støtter hundrevis av forskjellige skrifter, er målet med en brukermanual å lese lett. Å velge et lite antall kilder som samsvarer, er det beste alternativet for dette. Fontene kan enkelt deles inn i to typer: serif og sans serif.
   • Serif-skrifter har små dekorative linjer i endene av linjene som utgjør bokstavene. Denne typen skrifter fungerer best for store tekstblokker i størrelser mellom 10 og 12 i hoveddelen av en trykt manual. Eksempler inkluderer kilder som Times New Roman, Baskerville og Book Antiqua.
   • Sans serif-skrifter har bare linjene som utgjør bokstavene, uten dekorasjoner. Disse skriftene kan brukes i store tekstblokker i størrelser mellom 8 og 10 i digitale manualer, da mangelen på serif gjør det vanskelig å lese i størrelser over 12. Disse skriftene kan imidlertid brukes i store størrelser i titler og overskrifter, i tillegg til å være bra for fotnoter og tall i kolonner og tabeller. Eksempler inkluderer skrifter som Arial, Calibri og Century Gothic.
   • Velg vanlige skrifter, som Arial eller Times New Roman, for manualer, men velg mer dekorative alternativer for sitater og titler hvis du skriver en manual for et fantasy- eller science fiction-spill. Når det gjelder siteringer, kan du også beholde standardfont for teksten, men sette den i kursiv.
   • Når du har definert skriftene du vil bruke, oppretter du en testside for å se om de stemmer overens med papiret. Vis testen til personen som har makt til å definere utseendet til manualen før du fortsetter.

2. 

   Tenk nøye gjennom sideoppsettet. Etter å ha valgt skriftene, er det nødvendig å velge oppsettet for alt som skjer på siden.
   • Generelt sett bør du sette tittelen eller kapittelnavnet i toppteksten eller bunnteksten, og du kan plassere tittelen på manualen på venstre side og tittelen på kapitlet på høyre side. Sett også inn sidetallene i disse regionene, enten på høyre side (i toppteksten eller bunnteksten) eller i midten (bare i bunnteksten). Du kan skille den første siden i hvert avsnitt eller kapittel ved å plassere sidenummeret i midten av bunnteksten, mens påfølgende sider er nummerert i det ytre hjørnet av overskriften.
   • Du kan sette inn utrop i fargede eller skyggelagte bokser for å skille dem fra resten av teksten. Velg et farge- eller skyggenivå som ikke overlapper teksten.
   • Lag rimelige marginer på alle sider, og gi ekstra plass i kantene som skal bindes.

3. 

   Vurder typen binding. Hvis manualen har mer enn fire sider, må de sikres på noen måte. Interne dokumenter kan stiftes i øverste venstre hjørne av sidene, men håndbøker som følger med produktene blir vanligvis bundet ved hjelp av en av de tre metodene nedenfor:
   • Sidehefting er egnet for håndbøker som består av ark på 21 x 27,5 cm, 21 x 35 cm eller 27,5 x 42,5 cm. Billigere materialer 48 sider eller mindre er stiftet slik.
   • Sadelsøm er mer vanlig for tredjeparts referanseguider enn for håndbøker levert med andre produkter enn biler, selv om lengre manualer er bundet på denne måten. (Paint Shop Pro ble solgt med saltsydd guide når den ble produsert av JASC Software.)
   • Spiralen er egnet for guider som må brukes utendørs, der andre bindinger kan være for skjøre. Noen av disse håndbøkene har laminerte sider for å forhindre skader fra vann eller land.

4. 

   Lag en mal for manualen. Ulike tekstbehandlings- og publiseringsprogramvare har en funksjon for å lage en mal, slik at du skriver inn teksten, og den vises automatisk i den valgte skrifttypen for delen av manualen du jobber med. (Denne artikkelen ble opprinnelig skrevet med en Microsoft Word-mal.) De fleste av disse programmene har forhåndsdefinerte maler som kan tilpasses dine behov, så det er ikke nødvendig å lage en mal fra bunnen av.
   • Disse programvarene lar deg også lage "stiler", forhåndsdefinerer skrifter og størrelser for topptekst, bunntekst, titler og brødtekst. Du kan velge en av de definerte stilene (for eksempel "Overskrift 1", "Normal", "Sitat") eller lage din egen. Følg stilnavnkonvensjoner hvis du har flere klasser per tekst. (For eksempel identifiserer Word stiler for titler som "Tittel 1", "Tittel 2" osv. For de forskjellige nivåene med undertittel.) Prøv å lage alle stiler du vil bruke på forhånd, slik at du ikke trenger å stoppe og opprette dem i løpet av skriveprosessen.

Tips

• Bruk tekstvariabler der det er mulig. Det er mulig å tilordne verdier til dem, for eksempel navnet på et produkt eller tittelen på kapittelet, og sette dem inn i dokumentet i stedet for å skrive selve teksten. Når du forhåndsviser eller skriver ut håndboken, vil teksten komme i stedet for variabelen. Hvis produktnavnet endres, vil det være lettere å endre det i håndboken ved å endre variabelen enn ved å se etter den og erstatte den manuelt i dokumentet.

Nødvendige materialer

• Programvare for tekstbehandling eller publisering.
• Programvare for bilderedigering eller skjermdumping.