Wko

Hvordan lage en bruksanvisning

Brukerhåndbøker er skrevet guider i enten hard-kopi (papir) eller elektronisk dokument (PDF eller XPS) format som gir instruksjoner om hvordan du gjør eller bruke noe. Selv om "brukerveiledninger" er oftest tenkt på i form av dataprogrammer håndbøker, brukermanualer også følge datamaskiner og andre elektroniske apparater som TV, stereoanlegg, telefonsystemer og MP3-spillere, samt hvitevarer og plen og hage utstyr. Gode ​​brukermanualer utdanne brukerne om produktets egenskaper samtidig som du lærer dem hvordan de skal bruke disse funksjonene effektivt og er lagt ut for å være lett å lese og henvist til. Følgende er ting du bør vurdere når du oppretter effektive innholdet for og utforme utformingen av en brukermanual.

Trinn

Hvordan lage en bruksanvisning. Definer hvem brukeren er.
Hvordan lage en bruksanvisning. Definer hvem brukeren er.

Opprette passende brukerdokumentasjon

  1. 1
    Definer hvem brukeren er. For å skrive en vellykket bruksanvisningen, må du utvikle en profil av din bruker, enten formelt, ved å opprette en skriftlig profil, eller uformelt, ved å ta seg tid til å gjøre rimelige antagelser om brukerens egenskaper. En slik profil er nyttig når du er del av et team skrive brukerdokumentasjon og kan også være nyttig i å ta selve produktet fra konsept til endelig form. Ting å tenke på når du lager en brukerprofil inkluderer:
    • Der brukerne vil bruke bruksanvisningen, for eksempel hjemme, på kontoret, på en ekstern arbeidsplassen, eller i bilen. Dette kan avgjøre ikke bare innholdet, men stilen bruksanvisningen tar.
    • Hvordan brukerne vil bruke brukerhåndboken. Hvis den manuelle er en de vil konsultere bare sjelden eller å lete opp informasjon, bør det først og fremst skje i form av en referanse dokument. Hvis det er noe brukerne vil rådføre seg ofte i begynnelsen, bør referanse delen være ledsaget av en "Komme i gang"-delen og instruksjonene på de vanligste oppgavene produktet skal brukes til.
    • Hvor mye erfaring brukerne har med produktet eller andre liker det. Hvis produktet er nytt eller vesentlig forskjellig fra lignende produkter, må du ta med en forklaring på hvordan det skiller seg fra andre produkter, samt instruksjoner om hvordan du kommer i gang. Hvis produktet omhandler noe brukerne har ofte problemer med, for eksempel mange dataprogrammer, må du gi riktig informasjon og detaljer på en forståelig måte.
  2. 2
    Skrive til brukerens behov på en måte brukeren kan forstå. Med mindre brukeren har en teknisk bakgrunn, er det sannsynligvis best å unngå svært teknisk språk i favør av klare, enkle forklaringer. Teksten bør også være organisert på en måte som etterligner måten brukere mener; noteringsprodukt funksjoner gruppert etter funksjon ofte er mer fornuftig enn bare de som brukes oftest.
    • Noen ganger er det ikke å komme rundt ved hjelp av tekniske termer, for eksempel for en graf-lage program som inkluderer Fibonacci diagrammer sammen med mer vanlig pie og søylediagram. I et slikt tilfelle, er det nyttig å definere begrepet og gi noen bakgrunn, slik som en forklaring på hva Fibonacci diagrammer er og deres anvendelse i økonomisk analyse.
  3. 3
    Forklare problemet brukeren prøver å løse, deretter presentere løsningen på det. Tilbyr en funksjon som løsningen på et generelt problem fungerer fint når markedsføring av produktet, men når brukeren har produktet, han eller hun trenger for å finne ut hvordan å sette den i bruk. Identifisere spesifikke problemer brukeren vil møte, staten dem i bruksanvisningen, og følg med instruksjoner for å løse dem.
    • Hvis problemet er sammensatt, bryte det ned i mindre deler. Liste over hver del med instruksjoner om hvordan man kan løse eller takle det, og deretter følger med hver etterfølgende del på rad. Bryte informasjonen ned denne måten kalles "chunking."

Bruker manual komponenter

  1. 1
    Inkludere den aktuelle cover og tittel sider. Du trenger en forside for alle brukerhåndboken som er mer enn en referanse-kort og en tittel siden for noen manuell som dekker mer enn en brettet ark (fire eller flere sider i lengde).
    • Hvis håndboken er opphavsrettsbeskyttet, går en opphavsrett på både forsiden og tittelbladet.
    • Hvis det er vilkår for bruk av manuelle og produkt forbundet med det, plassere dem på innsiden av omslaget.
  2. 2
    Sett referanser til relaterte dokumenter i forordet. Hvis brukeren dokumentasjon er mer enn en manuell, gjør referanse til andre dokumenter, med den riktige versjonen tall, her. Forordet er også der for å sette en "Hvordan bruke denne Guide" delen hvis det er én.
  3. 3
    Inkludere en innholdsfortegnelse hvis den manuelle overstiger 10 sider.
  4. 4
    Sett instruksjoner / prosedyrer og referansemateriale i kroppen av håndboken. I de fleste tilfeller, prosedyrer og referansemateriale bør hver har sine egne seksjoner, selv om du kan fortelle brukeren å referere til spesifikke innholdet i en del fra den andre. På denne måten kan brukeren finne den informasjonen han eller hun er ute etter raskere.
    • Prosedyrer bør være skrevet på en konsistent struktur gjennom instruksjon delen av manualen. Begynn med en oversikt over oppgaven, og beskrive hva brukeren må gjøre og hva resultat han eller hun skal se. Trinn skal være nummerert og begynner med handlingsverb, som trinnene i hver del av denne artikkelen er skrevet.
    • Referansemateriale kan inneholde lister over alternativer, tips om feilsøking og ofte stilte spørsmål. Ordlister og indekser kan legges nær slutten av håndboken, selv om en liste over ofte brukte ord og uttrykk kan vises på forsiden. Indeksen kan utelates dersom den manuelle kjører mindre enn 20 sider.
  5. 5
    Bruk grafiske bilder som trengs for å støtte teksten. Grafiske bilder eller skjermbilder, kan illustrere enkelte punkter i den manuelle bedre enn tekst, særlig i kompliserte prosedyrer der brukerne må ha visuell bekreftelse på at de oppnår trinnene riktig. Grafiske bilder kan produseres ved hjelp av dataassistert tegning (DAK) eller grafisk redigering programvare, digitale kameraer og foto-redigering programvare, eller i tilfelle av screenshots, enten datamaskinens innebygde skjermen fange evne eller en grafikk program med skjermen fange evne.
    • Når du oppretter et grafisk bilde, lagre det i så komprimert et format som tekstbehandling eller desktop publishing program vil tillate deg å bruke. Du vil også ønsker å redusere den fysiske størrelsen på bildet til noe som vil passe lettere på siden og fortsatt gi tilstrekkelig detalj for brukeren. (Om nødvendig, kan det hende du trenger å klippe det opprinnelige bildet inn i deler og vise de relevante delene sammen med støtte teksten.)
    • Hvis du bruker flere grafiske bilder i prosedyrer, gjøre dem en jevn størrelse, enten i samme dimensjoner av lengde og bredde eller i samme forholdsmessig reduksjon fra sin opprinnelige størrelse. Dette vil gjøre bildene mer attraktivt for brukeren. På samme måte, når du oppretter skjermbilder fra en datamaskin, må du kontrollere at datamaskinen viser en standard fargevalg når du tar bilder hvis bruksanvisningen vil vise skjermbilder i farger.
    • Selv grafisk redigering programmer som Photoshop og Paint Shop Pro tilbyr anstendig skjermen fange evner, dedikerte skjermen fange programmer som SnagIt har også muligheten til enkelt å endre, katalog, og kommentere skjermdumper.

Utforme en lesbar bruksanvisningen

  1. 1
    Velg noen få lesbare fonter. Selv om datamaskiner kan støtte en rekke forskjellige skrifttyper, er målet for en brukerveiledning for å være en lett lesbar. Velge bare et lite antall skrifter som ser bra ut sammen er den beste måten å oppnå dette målet. Skrifter kan deles inn i to typer: serif og sans serif fonter.
    • Serif fonter funksjonen små pynt linjer i endene av de viktigste slag som danner bokstaven. Serif skrifter inneholder slike fonter som Times New Roman, Baskerville, og Book Antiqua. Serif fonter fungerer best for store biter av tekst vises i 10-12 punktstørrelse i hoveddelen av en trykt bruksanvisning.
    • Sans serif fonter vise bare de slag som danner bokstavene uten utsmykning. Sans serif skrifter inneholder slike skrifter som Arial, Calibri, og Century Gothic. Sans serif fonter kan brukes for store biter av tekst i størrelser fra 8 til 10 poeng i en PDF-eller web-basert manual, selv om mangel på serifs gjør setninger som vises i størrelsene 12 poeng eller større vanskeligere å lese. De kan imidlertid brukes effektivt i større størrelser til å vise titler og overskrifter, og de er også stor i de mindre størrelsene for fotnoter og tall i kolonner og tabeller.
    • Du bør generelt velge vanlig fonter som Arial eller Times New Roman for din brukerveiledning, selv om det kan være lurt å bruke en dekorativ skrift for sitater eller for titler hvis du skriver en brukermanual for et videospill med en fantasy eller science fiction-setting. (I tilfelle av sitater, kan du ofte få av med en av de klare fonter og vise pull sitat i kursiv.)
    • Når du har bestemt deg for skriftene du vil bruke, lage en prøve for å kontrollere at skriftene går godt sammen på papiret. Du vil også ønsker å vise denne prøven til den som har godkjenning over manuell utseende før du går videre med å skrive den.
  2. 2
    Gi noen trodde til oppsettet. Når du har valgt din bruksanvisning fonter, må du bestemme hvor alt går på sidene.
    • Vanligvis vil du ønsker å sette den manuelle tittelen eller kapittelet tittelen i topp-eller bunntekst, muligens ved hjelp av den manuelle tittelen på venstre side og kapitteltittelen på høyre side. Det er lurt å ha sidetall i topp-eller bunntekst også, enten på utsiden (topp-eller bunntekst) eller i midten (bunntekst only). Det kan være lurt å ha den første siden av hvert avsnitt eller kapittel skiller seg fra de andre sidene ved å plassere sidetallet i sentrum av bunntekst og påfølgende sider i utenfor hjørnet av spissen.
    • Det kan være lurt å ha bildeforklaring tekst i fargede eller skyggelagte boksene for å skille det fra resten av teksten. Pass på å velge en farge eller nivået av skyggelegging som ikke overvelde teksten.
    • Tillate rimelig gode marginer på alle sider, med ekstra plass på kantene som vil bli bundet sammen.
  3. 3
    Vurdere hvilken type binding for bruksanvisningen. Hvis bruksanvisningen går mer enn fire sider, vil sidene trenger å være bundet sammen på en eller annen måte. Selv om interne dokumenter kan stiftes sammen på hjørnet, er eksterne bruksanvisninger som følger med et produkt som regel bundet i en av tre måter:
    • Side-stifting er hensiktsmessig for håndbøker sammensatt av brettet 8,5 x 11-tommers (21 x 27.5-cm), 8,5 x 14-tommers (21 x 35-cm) eller 11 x 17-tommers (27.5 x 42.5-cm) ark av papir. Mest rimelige manualer av 48 sider eller færre er bundet på denne måten.
    • Ryggstifting er mer vanlig for tredjeparts referanse guider enn for brukermanualer at skipet med andre produkter enn biler, selv om noen lengthier brukerhåndbøker er bundet på denne måten. (Paint Shop Pro ble levert med en ryggstifting bundet brukerveiledningen når det ble produsert av JASC Software.)
    • Spiral binding er hensiktsmessig for brukerhåndbøker laget for å brukes i mer robuste innstillinger, for eksempel utendørs, der side-stiftede eller ryggstiftes manualer ville falle fra hverandre. Noen spiral-bundet manualer kan også ha laminerte sider for å holde dem fra å bli ødelagt hvis den manuelle blir våt eller gjørmete.
  4. 4
    Bygg en mal dokument for manuell din. Mange tekstbehandling og desktop publishing programmer tilbyr deg muligheten til å lage en mal dokument for din bruksanvisningen, slik at mens du skriver, vil teksten automatisk vises i skriften du valgte for den delen av manualen du jobber med. (Denne artikkelen, faktisk ble skrevet i utgangspunktet bruker en Microsoft Word-mal.) De fleste av disse programmene har også et sett med forhåndsdefinerte maler som du kan endre for dine behov, i stedet for å lage malen fra scratch.
    • Tekstbehandling og desktop publishing programmer tilbyr også muligheten til å opprette "stiler", forhåndsinnstilt skrift og punkt-størrelse formater for topptekst, bunntekst, overskrifter og brødtekst. Du kan velge en av de definerte stil navn (for eksempel "Overskrift1", "Normal", "Quote") eller lage din egen stil med sitt eget navn. Så mye som mulig, følger konvensjonene for etablerte stilnavnene hvis du har flere stiler for samme klasse av tekst. (For eksempel, Microsoft Word-etiketter tekst stiler for overskrifter som "Overskrift1", "Heading2," osv. for overskrifter fra den største overskriften gjennom flere nivåer av underoverskrifter.) Prøv å lage alle frisyrene du trenger på forhånd, slik at du don ' t nødt til å stoppe og lage dem under selve skriveprosessen.

Tips

  • Gjøre bruk av feltkoder eller tekst variabler der det er mulig. Du kan tilordne dem verdier, for eksempel navnet på et produkt, jo manuell eller et kapittel tittel og sted inne dokumentet i stedet for å skrive selve teksten. Når du forhåndsvise eller skrive ut manualen, vil teksten fylle ut for variabelen. Dersom produktets navneendringer, eller hvis du endrer navnet på manuell eller et kapittel, vil det være lettere å endre informasjonen ved å endre verdien av teksten variable enn ved å gjøre et søk og erstatt av dokumentet.

Ting du trenger

  • Tekstbehandling eller desktop publishing program
  • Grafisk redigering eller skjermen fange program