En brukerveiledning er en håndbok i papir eller elektronisk format (PDF eller XPS) som gir instruksjoner om en fremgangsmåte eller bruk av noe. Selv om "brukermanualer" ofte er knyttet til dataprogramguider, er brukerhåndbøker også utstyrt med datamaskiner og andre elektroniske enheter, for eksempel fjernsyn, stereoanlegg, telefonsystemer, MP3 -spillere og husholdnings- og hageutstyr. En god brukerveiledning utdanner brukerne om produktfunksjoner mens de lærer dem hvordan de bruker funksjonene effektivt. Brukerveiledningen er strukturert på en slik måte at den er lett å lese og referere til. Her er noen trinn du må vurdere når du utvikler effektivt innhold og utformer brukerveiledningsoppsett.
Steg
Del 1 av 3: Lage en passende brukerhåndbok
Trinn 1. Bestem hvem som skal bruke guiden
For å skrive en god brukerveiledning må du utvikle en brukerprofil, enten formelt ved å opprette en skriftlig profil eller uformelt ved å ta deg tid til å gjøre rimelige antagelser om brukeregenskaper. Slike profiler er nyttige når du er en del av et brukerguide -skriveteam og når du jobber med det tiltenkte produktet fra konsept til endelig form. Tenk på følgende faktorer når du oppretter en brukerprofil:
- Brukerens plassering vil bruke guiden, for eksempel hjemme, på kontoret, på en avsidesliggende arbeidsplass eller i bilen. Denne faktoren bestemmer ikke bare innholdet, men også skrivestilen som guiden vil vedta.
- Hvordan brukeren vil bruke guiden. Hvis de sjelden bruker den eller bare trenger den for å finne informasjon, er det best hvis guiden er laget i form av et referansedokument. På den annen side, hvis brukeren vil bruke den regelmessig i begynnelsen, bør referansedelen ledsages av en "Hvordan komme i gang" -del og instruksjoner om de vanligste funksjonene som produktet skal utføre.
- Hvor mye erfaring brukeren har med produktet eller lignende. Hvis produktet er nytt eller veldig forskjellig fra lignende produkter, må du inkludere en forklaring på hvordan det skiller seg fra andre og instruksjoner om hvordan du bruker det. Hvis produktet håndterer noe som brukerne ofte synes er vanskelig, for eksempel et dataprogram, må du gi passende informasjon og detaljer på en forståelig måte.
Trinn 2. Lag en guide som passer brukerens behov på en måte de kan forstå
Hvis brukerne ikke er teknisk kunnskapsrike mennesker, er det sannsynligvis best å unngå svært teknisk språk og gi klare og enkle forklaringer. Tekst bør også organiseres på en måte som ligner måten brukeren tenker på. Å vise produktfunksjoner gruppert etter funksjon gir ofte mer mening enn de mest brukte funksjonene.
Noen ganger er det uunngåelig å bruke tekniske termer, for eksempel for kartleggingsprogrammer som inkluderer Fibonacci -diagrammer sammen med sektordiagrammer og de mer vanlige stolpediagrammene. I et tilfelle som dette ville det være bedre hvis du definerer begrepene og gir informasjon, for eksempel en forklaring på hva Fibonacci -diagrammet er og hvordan det brukes i finansiell analyse
Trinn 3. Beskriv problemet brukeren prøver å løse, og gi deretter en løsning på problemet
Å tilby funksjoner som løsninger på vanlige problemer er greit når man annonserer et produkt, men når en kunde eier produktet, må han eller hun forstå hvordan det skal brukes. Identifiser problemet som brukeren vil støte på, beskriv det i brukerveiledningen, etterfulgt av instruksjoner for å løse det.
Hvis problemet er komplekst, del det opp i mindre biter. Skriv ned hver seksjon med instruksjoner om hvordan du løser den eller håndterer den, og følg deretter hverandre i rekkefølge. Å bryte informasjon på denne måten er kjent som clustering eller splitting -metoden
Del 2 av 3: Komponenter i brukerhåndboken
Trinn 1. Lag et passende omslag og tittelside
Du trenger et omslag for en brukerveiledning som er mer enn et referansekort og en tittelside for en guide som inneholder mer enn et brettet ark (4 sider eller mer i lengde).
- Hvis guiden er beskyttet av opphavsrett, må merknaden om opphavsrett være inkludert på forsiden og baksiden, samt på tittelsiden.
- Hvis det er vilkår og betingelser for bruk av guiden og produktene knyttet til den, må du inkludere dem på innsiden av forsiden.
Trinn 2. Legg en referanse til det relaterte dokumentet i innledningen
Hvis det er mer enn én brukerveiledning, kan du referere til et annet dokument, inkludert riktig versjonsnummer, her. Forordet er også et sted å sette delen "Slik bruker du denne veiledningen" hvis det er en.
Trinn 3. Inkluder en innholdsfortegnelse hvis veiledningen er lengre enn 10 sider
Trinn 4. Legg instruksjoner/prosedyrer og referansemateriale på guiden
I de fleste tilfeller bør både prosedyren og referansematerialet ha hver sin seksjon. Du kan imidlertid be brukerne om å referere til spesifikt innhold i en seksjon og skille det fra andre seksjoner. På denne måten kan brukeren raskt finne informasjonen han leter etter.
- Prosedyrer bør skrives i en konsistent struktur gjennom instruksjonene i håndboken. Start med en oversikt over produktets funksjonalitet, og forklar deretter hva brukeren skal gjøre og hvilke resultater han eller hun vil få eller se. Trinnene bør være nummerert og begynne med et handlingsverb, på samme måte som trinnene er skrevet i hver del av denne artikkelen.
- Referansemateriell kan inneholde sjekklister, feilsøkingstips og vanlige spørsmål. En ordliste og indeks kan legges til på slutten av veilederen, selv om en ordliste med ofte brukte termer kan gis i begynnelsen. Indeksen kan utelates hvis guiden har mindre enn 20 sider.
Trinn 5. Bruk grafiske bilder etter behov for å støtte tekst
Grafiske bilder eller skjermbilder kan bedre illustrere visse punkter i en guide enn tekst, spesielt i komplekse prosedyrer der brukerne trenger visuell bekreftelse for å sikre at de følger trinnene riktig. Grafiske tegninger kan opprettes ved hjelp av datamaskinstøttet utkast (CAD) eller grafikkredigeringsprogrammer, digitale kamera- og fotobehandlingsprogrammer, eller hvis du vil bruke skjermbilder, kan du bruke skjermdumpfunksjonene som er innebygd i datamaskinen eller et grafikkprogram med skjermopptaksmuligheter.
- Når du har opprettet et grafisk bilde, lagrer du det i et komprimert format, slik at du kan bruke det i et tekstbehandlings- eller skrivebordsforlag. Du må også redusere størrelsen på bildet for å passe bedre til siden, men likevel gi brukeren fullstendige detaljer. (Om nødvendig kan du beskjære det opprinnelige bildet i seksjoner og vise de relevante seksjonene sammen med støttetekst).
- Hvis du bruker flere grafiske bilder i prosedyren, må du sørge for at bildene er laget i en jevn størrelse, enten i samme lengde og bredde eller i forhold til størrelsen på det opprinnelige bildet. På den måten vil bildet se mer attraktivt ut for brukerne. Det samme gjelder når du tar skjermbilder fra en datamaskin; Sørg for at datamaskinen viser standard fargeskjema når du tar bilder, ellers viser veiviseren et fargeskjermbilde.
- Selv om bilderedigeringsprogrammer som Photoshop og Paint Shop Pro har gode bildefangstmuligheter, tilbyr programmer dedikert til å ta skjermbilder som Snagit også muligheten til enkelt å endre, katalogisere og kommentere skjermbilder.
Del 3 av 3: Utforming av en brukervennlig brukerhåndbok
Trinn 1. Velg noen lettleste skrifttyper
Selv om en datamaskin kan støtte en rekke fonter, er formålet med å lage en brukerveiledning lett å lese. Å velge flere matchende skrifttyper er den beste måten å oppnå dette målet på. Skrifter kan grupperes i to typer: serif og sans serif.
- Serif -fonter har små dekorative linjer i enden av hovedlinjene som består av bokstavene. Serifskrifttypene inkluderer Times New Roman, Baskerville og Book Antiqua. Serif-fonter er perfekte for de fleste tekstene som vises i størrelsene 10-12 i hoveddelen for utskriftsguider.
- Sans serif -fonter inneholder bare linjene som består av bokstavene, uten pynt. Skrifter som tilhører sans serif -gruppen inkluderer Arial, Calibri og Century Gothic. Sans serif -fonter kan brukes i de fleste tekststørrelser 8 til 10 i PDF -filer eller på nettbaserte guider, selv om det å være uten pynt gjør setninger som vises i fonter 12 eller større, vanskeligere å lese. Imidlertid kan fonter brukes effektivt i større størrelser for å vise overskrifter og overskrifter, og i mindre størrelser er de perfekte for fotnoter og tall i kolonner og tabeller.
- Generelt er det best å velge en enkel skrift som Arial eller Times New Roman for guiden din, selv om du kan bruke en dekorativ skrift for sitater eller titler hvis du skriver en guide for et videospill i fantasy- eller science fiction -omgivelser. (Når det gjelder sitater, kan du ofte bruke en enkel skrift og vise hele sitatet i kursiv).
- Etter at du har bestemt deg for hvilke fonter du skal bruke, må du opprette eksempelsider for å bekrefte at de ser bra ut på papir. Du bør også vise denne eksempelsiden til personen som er ansvarlig for å gi godkjenning for visning av guiden før du fortsetter med skriveprosessen.
Trinn 2. Tenk på oppsettet
Når du har valgt en skrift for guiden, må du bestemme hvordan innholdet skal struktureres på toppen av siden.
- Generelt bør du sannsynligvis plassere dokumenttittelen eller kapiteltittelen i topptekst eller bunntekst, kanskje ved å bruke guideoverskriftene til venstre på siden og kapitteloverskriftene til høyre på siden. Du må plassere sidenummeret i topptekst eller bunntekst, enten utenfor (topptekst eller bunntekst) eller sentrert (bare i bunntekst). Du må kanskje også skille den første siden i hver seksjon eller kapittel fra andre sider ved å plassere sidenummeret i bunnteksten og neste side i det ytre hjørnet av toppteksten.
- Du må kanskje sette inn teksten i en farget boks eller en blokkboks for å skille den fra resten av teksten. Sørg for at du velger et farge- eller blokkeringsnivå, slik at det ikke gjør teksten vanskelig å lese.
- La det være en ganske bred margin på alle sider, med ekstra plass i kantene som skal bindes.
Trinn 3. Vurder typen volum for brukerhåndboken
Hvis guiden er lengre enn 4 sider, må sidene være bundet på en bestemt måte. Selv om interne dokumenter kan stiftes med en stiftemaskin i hjørnet av siden, blir den eksterne brukerhåndboken som fulgte med produktet vanligvis stiftet med en av følgende 3 metoder:
- Stiftemetoden for sider (festet til sidene av siden med stiftemaskin) for guider som er skrevet ut på 21 x 27,5 cm, 21 x 35 cm eller 27,5 x 42,5 cm brettet papir. De fleste billige guider på 48 sider eller færre er bundet på denne måten.
- Sømstingmetoden (sydd på siden av siden) brukes oftere for tredjeparts referanseguider enn guider som følger med andre produkter enn biler, selv om noen lengre guider er bundet på denne måten. (Paint Shop Pro Guide inkluderte opprinnelig en veiledning for saksøm mens den fremdeles ble produsert av JASC Software).
- Spiralbinding er best egnet for guider som brukes i tøffere miljøer, for eksempel utendørs (i så fall er stifting ved siden av stifter og sømmen ikke sterk nok til å få sider til å skli). Noen spiralbundne guider kan også ha sider som er laminert med plast for å forhindre at de blir skadet når de er våte eller utsettes for gjørme.
Trinn 4. Lag et mal dokument for veiledning
Mange tekstbehandlings- og skrivebordsprogrammer gir deg muligheten til å lage maldokumenter for brukerveiledninger. Så mens du skriver, vises teksten automatisk med skriften du valgte for den delen av veiviseren du jobber med. (Egentlig ble denne artikkelen opprinnelig skrevet med en Microsoft Word -mal). De fleste av disse programmene inneholder også et standard sett med maler som du kan endre etter behov, slik at du ikke trenger å lage dine egne fra bunnen av.
