Wkono

Hvordan skrive en manuell

Skrive en bruksanvisning kan virke som en skremmende oppgave, men det er enklere enn du tror! Denne fremgangsmåten gjelder for enhver skriftlig instruksjon, fra svært enkle (Hvordan Clap) til intenst komplisert (Hvordan bygge en Semiconductor.)

Trinn

Hvordan skrive en manuell. Prøv en hands-on tilnærming.
Hvordan skrive en manuell. Prøv en hands-on tilnærming.

Bli kjent med faget

  1. 1
    Dette er nøkkelen. Det kan virke innlysende, men kunnskap er nøkkelen til å skrive en vellykket manual. For eksempel, hvis du skriver et kamera manuelt, vel vitende om at en f-stop og lukkertid er ikke bare to separate funksjoner-de-men å vite hvordan de samhandler med hverandre vil gjøre det mye enklere for deg å beskrive hver fungere som gjelder hele.
  2. 2
    Snakk med eksperter. Hvis din rolle er rett og slett forfatteren i stedet for saksområdet ekspert, involvere kunnskapsrike folk gjennom hele prosessen og sørge for at de gjennom arbeidet ditt. Deres kunnskap og råd er uvurderlig.
  3. 3
    Prøv en hands-on tilnærming. Hvis det er mulig, gjøre ting du skriver om vil, i det minste, gi deg en følelse for hva brukeren vil ønske å lære.
  4. 4
    Les deg opp på emnet. Lær å snakke foredraget, og bli fortrolig med det du skriver om.
    • Manualer av tilsvarende produkter vil vise deg hvordan andre forfattere har taklet emnet. # ** Se etter likhetstrekk mellom forfattere, noe som indikerer både felles funksjonalitet og felles tilnærming til å beskrive noe.
      • Se etter forskjeller som skiller seg ut. De vil trolig være funksjoner som er unike for et gitt produkt. Produktet kan eller ikke kan inkludere disse funksjonene, eller kan ha alternative måter å løse problemet som du kan beskrive, øke verdien av produktet. Mens jobben din kan skrive en how-to, viser kundene verdien av kjøpet er en flott måte å oppmuntre dem til å fortsette å lese.
    • Sluke handel magasiner. Finn ut hvordan folk som bruker produktene arbeide med dem fra dag til dag. De kan ønske det var en funksjon som løste deres spesielle problem, og hvis produktet er løsningen, som trenger å bli markert.

Planlegg manuell layout

  1. 1
    Bryte det ned. Enten en enkel steg-for-steg instruksjonsark, eller en manual for et 35mm kamera, bryte det ned i fordøyelige biter har flere fordeler:
    • Det lar deg fokusere på enkelte deler av helheten. Målet ditt er å gjøre brukeren med hvordan å lære prosessen. Hvordan å utføre funksjonen kan stå for en tutorial på slutten, hvis ønskelig, eller til venstre for brukeren å oppdage på egen hånd.
  2. 2
    Følger en logisk rekkefølge. Det ville gjøre noe godt, for eksempel for å beskrive hvordan Blitsen på kameraet fungerer før du har vist hvordan du setter på objektivet, laste filmen, slå på kameraet, og justere fokus. Dette er spesielt nyttig hvis du ikke kjenner saksområdet godt.
  3. 3
    Bruk dette som mal for innholdsfortegnelsen.
  4. 4
    Gjennomgå trinnene. Når du har definert de logiske deler, vurdere dem å sørge for at alt er dekket.
  5. 5
    Samle dine forsyninger. Har elementene som du beskriver på hånden og klar til bruk som beskrevet i manualen. Hvis du gjør en papir boks, har papir, saks, tape, lim, og en linjal hendig. Hvis du skriver om et kamera, gjør at kameraet er demontert. Hvis mulig, bør produktet du skriver om være tilbake i boksen på dette punktet.

Begynn å skrive

  1. 1
    Skriv innledningen. Dette vil sette tonen for hele håndboken, og vil gi brukeren en idé om hva slags manuell de er i ferd med å fordøye. Vil det være lett og morsomt, eller grei og no-nonsense? Det avhenger av lesekretsen. Det er mye mer rom for verbal lek lære barna å lage en papir boks enn det er undervisning en lege hvordan du går frem med åpen hjertekirurgi. Etablere tonen tidlig og holde den tonen gjennom hele bruksanvisningen.
  2. 2
    Utfør hvert trinn som du skriver. Ikke bare gir dette skrivingen luften av ærlighet og autentisitet, du også sikre at ingenting vil bli utelatt.
    • Hvis en eller annen grunn, er det ikke mulig å gjøre trinnene, tror dem gjennom grundig og konsultere noen som er ekspert.
  3. 3
    Antall trinnene. Dette gjør det lettere for folk å følge med, og å se tilbake på bør de miste sin plass.
    • Hvis du skriver på papir, må du la det være plass for filer mellom hvert trinn. Husk å nummerere dine skritt hvis du legger til mer i.
  4. 4
    Inkluder tips og advarsler. Som du skriver, kan du innse at dersom bruker utfører et skritt uforsiktig, kan det føre til et problem.
    • Derimot, hvis det er noen bit av kunnskap som vil gjøre brukeren oppgave enklere og mer interessant, legger det i.
  5. 5
    Teste det ut. Kun ved hjelp av din skriftlige instruksjoner, gjør du ting du skriver om. Skulle du finne steder hvor dine instruksjoner mangler, legg inn den nødvendige informasjonen. Gjenta dette trinnet til du har alle trinnene og kan gjøre hva du underviser uten å måtte legge til notater.
    • Tenk å ha en venn eller to bruke den manuelle. Se dem nøye når de lærer å bruke produktet. Se hvor de zip gjennom det. Se hvor de får tapt, forvirret, eller mislykkes på oppgaven. Lytte til hva de har å si, deretter justere manuelt tilsvarende.
  6. 6
    Korrekturlese manualen. Du ønsker ikke å sende den endelige korrekturleser (være at etaten eller din ektefelle) en manuell full av skjærende feil.

Formatering

  1. 1
    Start på øverste nivå. Når du har alle de nødvendige tiltakene beskrevet, gått gjennom manuelt for å finne de åpenbare kategorisjefene.
    • Tittel dem, og legg merke til deres steder.
  2. 2
    Skriv en innholdsfortegnelse, hvis det er aktuelt. Se på hvordan Google er lagt ut som et eksempel. Hovedsiden tilbyr mange seksjonsledere. Når du åpner et avsnitt, lister det mange underkategorier, og underkategorier liste artikler. Jo mer detaljert manual er, jo flere kategorier og underkategorier du trenger. (Trenger ingen, Hvordan Skaffe seg en Whistle trenger noen, og hvordan å spille fløyte trenger mange!)
  3. 3
    Korrekturlese igjen. Ja, du gjorde det grundig en gang allerede. Gjør det en gang vil utvilsomt ta noen flere mindre feil eller steder hvor manuell bare er ikke klart.
    • For en mer omfattende manual, kan du også benytte anledningen til å merke alle de små emner, og bruke denne informasjonen til å lage en indeks.
  4. 4
    Velg en tittel.

Tips

  • Når det er mulig, illustrerer dine instruksjoner! Hvis du ikke kan sette inn bilder, henvise studenten til noe felles som et eksempel. For eksempel, i formatering, trinn to av disse instruksjonene, er utseendet til Googles layout brukes til å illustrere hvordan en innholdsfortegnelse kan bli opprettet.
  • Hvis du kan, ha en nybegynner gjøre en testkjøring av manuell og skrive ned alle spørsmål de spør! Dette vil hjelpe deg å fylle ut feltene og gjøre manuelle mye mer nyttig.
  • Selv om noe virker opplagt for deg, skrive ut trinnene! Det vil hjelpe deg å unngå glatter over noe din brukeren ikke vet. Det er bedre å sette inn ekstra informasjon snarere enn å utelate viktige skritt.
  • Hvis du skriver en veldig detaljert manual som krever kapitler, for eksempel hvordan å spille fløyte, kanskje det første steget faktisk være å liste opp alle kapitlene, som for eksempel velger en fløyte, Montering og omsorg, Tone Production, Metoder for Hekling og din første Piece, etc. Du vil da gjelde de grunnleggende reglene for å skrive en manual til hvert kapittel fordi hvert kapittel er som en egen håndbok i seg selv!
  • Skriver hver del på en egen side (eller på en datamaskin) vil gjøre redigeringen enklere. Du kan lettere ordne hvis du har plass til å jobbe og kan finne dine edit karakterer. På datamaskinen, la tre eller fire linjer (ved å trykke inn flere ganger) mellom hvert trinn, slik at du enkelt kan finne pausene.