Wko

Hvordan skriver man en manual

Skrivning en brugsanvisning kan virke som en skræmmende opgave, men det er nemmere end du tror! Disse trin gælder for alle skriftlige instruktion, fra den meget simple (Sådan Clap) til intenst kompliceret (Hvordan man opbygger en Semiconductor.)

Steps

Hvordan skriver man en manual. Prøv en hands-on tilgang.
Hvordan skriver man en manual. Prøv en hands-on tilgang.

Få at vide emnet

  1. 1
    Det er nøglen. Det kan virke indlysende, men viden er nøglen til at skrive en vellykket manual. For eksempel, hvis du skriver et kamera manual vel vidende, at en f-stop og lukkertid ikke er blot 2 separate funktioner-de-men at vide hvordan de interagerer med hinanden, vil gøre det meget lettere for dig at beskrive hver fungere som den vedrører hele.
  2. 2
    Tal med eksperter. Hvis din rolle er simpelthen forfatteren snarere end emnet ekspert, involvere vidende mennesker i hele processen og sikre, at de gennemgå dit arbejde. Deres viden og rådgivning er uvurderlig.
  3. 3
    Prøv en hands-on tilgang. Hvis det er muligt, at gøre de ting du skriver om vilje, i det mindste, at give dig en fornemmelse for, hvad brugeren gerne vil lære.
  4. 4
    Læs op på emnet. Lær at tale talen, og bliver fortrolig med det produkt, du skriver om.
    • Manualer af lignende produkter vil vise dig hvordan andre forfattere har tacklet emnet. # ** Kig efter ligheder blandt de forfattere, der viser både fælles funktionalitet og fælles tilgange til at beskrive noget.
      • Kig efter forskelle, der skiller sig ud. Det er sandsynligvis være funktioner, der er unikke for et givet produkt. Dit produkt kan eller ikke kan omfatte de funktioner, eller kan have alternative måder at løse det problem, du kan beskrive, øge værdien af ​​dit produkt. Mens dit job kan være at skrive en how-to, der viser kunderne værdien af ​​deres køb er en fantastisk måde at opmuntre dem til at fortsætte med at læse.
    • Devour fagblade. Find ud af hvordan de mennesker, der anvender produkterne arbejder med dem dag-til-dag. De ønsker måske der var en funktion, der løste deres særlige problem, og hvis dit produkt er løsningen, der skal fremhæves.

Planlæg din manual layout

  1. 1
    Bryde det ned. Hvorvidt en enkel trin-for-trin instruktion ark eller en manual for en 35mm digitalt kamera, har bryde det ned i fordøjelige bidder flere fordele:
    • Det lader dig fokusere på de enkelte dele af helheden. Dit mål er at sætte brugeren med at lære processen. Sådan udføres den funktion kan afleveres til en tutorial i slutningen, hvis det ønskes, eller til venstre for brugeren at opdage på egen hånd.
  2. 2
    Følg en logisk rækkefølge. Det ville gøre noget godt, for eksempel, at beskrive, hvordan blitzen på et kamera fungerer, indtil du har vist, hvordan man montere objektivet, indlæse film, tænde kameraet og justere fokus. Dette er især nyttigt, hvis du ikke kender emnet godt.
  3. 3
    Brug dette som din skabelon til indholdsfortegnelsen.
  4. 4
    Gennemgå dine skridt. Når du har defineret de logiske sektioner, gennemgå dem for at sikre, at alt er dækket.
  5. 5
    Saml dine leverancer. Har de elementer, du beskriver på hånden og klar til brug som beskrevet i vejledningen. Hvis du laver en papir kasse, har papir, sakse, tape, lim, og en lineal handy. Hvis du skriver om et kamera, så sørg for at kameraet er afmonteret. Hvis det er muligt, bør produktet du skriver om være tilbage i kassen på dette punkt.

Begynd at skrive

  1. 1
    Skriv indledningen. Dette vil sætte tonen for hele manualen, og vil give brugeren en idé om, hvad slags manual de er ved at fordøje. Vil det være let og underholdende, eller ligetil og no-nonsense? Det afhænger af din læserskare. Der er meget mere plads til verbale leg lære børn at lave et papir kasse end der er undervisning en læge hvordan vi kommer videre med en hjerteoperation. Etablere tonen tidligt og holde denne tone i vejledningen.
  2. 2
    Udføre hvert trin, som du skriver. Dette er ikke blot giver din skrivning luften af ​​ærlighed og autenticitet, du også sikre intet vil blive udeladt.
    • Hvis en eller anden grund, er det ikke muligt at gøre de skridt, tænke dem igennem grundigt og konsultere nogen, der er en ekspert.
  3. 3
    Nummer trinene. Dette gør det nemmere for folk at følge med, og til at vende tilbage til, bør de miste deres plads.
    • Hvis du skriver på papir, skal du sørge for at efterlade plads til tilføjelser mellem hvert trin. Husk at omnummerere dine skridt, hvis du tilføjer mere i.
  4. 4
    Medtag tips og advarsler. Som du skriver, kan du indser, at hvis brugeren udfører et skridt uforsigtigt, kan det forårsage et problem.
    • Omvendt, hvis der er en vis smule viden, der vil gøre brugerens opgave nemmere eller mere interessant, tilføje det i.
  5. 5
    Test det ud. Brug kun dine skriftlige instrukser, de ting du skriver om gøre. Skulle du finde steder, hvor dine instruktioner der mangler, tilføje de nødvendige oplysninger. Gentag dette trin, indtil du har alle de trin og kan gøre, hvad du underviser uden at skulle tilføje noter.
    • Overvej at have en ven eller to bruge manualen. Se dem nøje, når de lærer at bruge produktet. Se, hvor de zip gennem det. Se hvor de får tabt, forvirret eller svigte på opgaven. Lyt til, hvad de har at sige, og derefter justere din manual overensstemmelse hermed.
  6. 6
    Læse korrektur på din manual. Du ønsker ikke at sende din endelige korrekturlæser (være, at dit firma eller din ægtefælle) en manual fuld af grelle fejl.

Formatering

  1. 1
    Start på topniveau. Når du har alle de nødvendige detaljerede trin, gå gennem din manual for at finde de oplagte kategori hoveder.
    • Titel dem og notere deres placeringer.
  2. 2
    Skriv en indholdsfortegnelse, hvis relevant. Se på den måde Google er lagt ud som et eksempel. Den vigtigste side byder på mange afsnit hoveder. Når du åbner en sektion, lister mange underkategorier, og underkategorier listen artikler. De mere detaljerede din manual er, jo flere kategorier og underkategorier, du får brug for. (Behov none, hvordan at skære en Whistle behov et par, og hvordan man spiller fløjte behov mange!)
  3. 3
    Korrekturlæse igen. Ja, du gjorde det grundigt allerede én gang. Gør det en anden gang vil utvivlsomt fange et par mere mindre fejl eller steder, hvor din manual bare ikke klar.
    • For en mere omfattende manual, kan du også benytte lejligheden til at bemærke alle de små emner, og bruge disse oplysninger til at oprette et indeks.
  4. 4
    Vælg en titel.

Tips

  • Når det er muligt, viser dine instruktioner! Hvis du ikke kan indsætte billeder, se dine studerende til noget almindeligt som et eksempel. For eksempel, i formatering trin 2 i denne vejledning, er udseendet af Googles layout, der anvendes til at illustrere, hvordan en indholdsfortegnelse kan oprettes.
  • Hvis du kan, få en novice at gøre en testkørsel af din manual og skrive ned hver spørgsmål, de spørger! Dette vil hjælpe dig udfylde de tomme felter og gøre din manual meget mere nyttigt.
  • Selv hvis noget synes indlysende for dig, skriver de skridt! Det vil hjælpe dig med at undgå dække over noget, din bruger ikke kender. Det er bedre at sætte i ekstra oplysninger i stedet udelade vigtige skridt.
  • Hvis du skriver en meget detaljeret manual, der kræver kapitler, såsom hvordan man spiller på fløjte, kan din første skridt faktisk være at liste alle de kapitler, såsom Valg af en fløjte, Montage og pleje, Tone Produktion, Metoder til Fingering, Din Første Piece, etc. Du vil derefter anvende de grundlæggende regler for at skrive en manual til hvert kapitel, fordi hvert kapitel er som en separat manual i sig selv!
  • Skrivning hver sektion på en separat side (eller på en computer), vil gøre redigering lettere. Du kan nemmere omarrangere hvis du har plads til at arbejde og kan finde dine redigere mærker. På computeren, lad 3 eller 4 linjer (ved at ramme ind flere gange) mellem hvert trin, så du nemt kan finde de pauser.