Sådan skriver du en manual (med billeder)

Indholdsfortegnelse:

Sådan skriver du en manual (med billeder)
Sådan skriver du en manual (med billeder)

Video: Sådan skriver du en manual (med billeder)

Video: Sådan skriver du en manual (med billeder)
Video: How to Create User Manual or User Guide Documentation Very Easily 2024, Marts
Anonim

At skrive en instruktionsbog kan virke som en skræmmende opgave, men det er lettere end du tror! Disse trin gælder for enhver skriftlig instruktion, fra det meget enkle (Sådan klapper du) til det meget komplicerede (Sådan bygger du en halvleder.)

Trin

Del 1 af 4: Lær emnet at kende

Skriv en manual Trin 1
Skriv en manual Trin 1

Trin 1. Dette er nøglen

Det kan virke indlysende, men viden er nøglen til at skrive en vellykket manual. For eksempel, hvis du skriver en kamerahåndbog, ved at vide, at et f-stop og lukkerhastigheden ikke kun er to separate funktioner-de er-men at vide, hvordan de interagerer med hinanden, vil gøre det meget lettere for dig at beskrive hver fungere som det vedrører helheden.

Skriv en manual Trin 2
Skriv en manual Trin 2

Trin 2. Tal med eksperter

Hvis din rolle simpelthen er forfatteren frem for fageksperten, skal du involvere kyndige mennesker under hele processen og sørge for, at de gennemgår dit arbejde. Deres viden og råd er uvurderlige.

Skriv en manual Trin 3
Skriv en manual Trin 3

Trin 3. Prøv en praktisk tilgang

Hvis det er muligt, vil det i det mindste give dig en fornemmelse af, hvad brugeren vil lære.

Skriv en manual Trin 4
Skriv en manual Trin 4

Trin 4. Læs om emnet

Lær at tale, og bliv fortrolig med det produkt, du skriver om.

  • Manualer til lignende produkter viser dig, hvordan andre forfattere har tacklet emnet.

    • Se efter ligheder blandt forfatterne, hvilket angiver både fælles funktionalitet og fælles tilgange til at beskrive noget.
    • Se efter forskelle, der skiller sig ud. Det er sandsynligvis funktioner, der er unikke for et givet produkt. Dit produkt indeholder måske eller ikke disse funktioner eller har alternative måder at løse det problem, som du kan beskrive, hvilket øger dit produkts værdi. Selvom dit job måske skriver en vejledning, er det en god måde at opmuntre dem til at læse videre ved at vise kunderne værdien af deres køb.
  • Fortær fagblade. Find ud af, hvordan de mennesker, der bruger produkterne, arbejder med dem i det daglige. De kunne ønske, at der var en funktion, der løste deres særlige problem, og hvis dit produkt er løsningen, skal det fremhæves.

Del 2 af 4: Planlæg dit manuelle layout

Skriv en manual Trin 5
Skriv en manual Trin 5

Trin 1. Opdel det

Uanset om det er et enkelt trin-for-trin instruktionsark eller en manual til et 35 mm digitalkamera, har det flere fordele at opdele det i fordøjelige bidder:

Det lader dig fokusere på individuelle dele af helheden. Dit mål er at gøre brugeren bekendt med, hvordan man lærer processen. Sådan udføres funktionen kan efterlades til en vejledning i slutningen, hvis det ønskes, eller overlades til brugeren at opdage på egen hånd

Skriv en manual Trin 6
Skriv en manual Trin 6

Trin 2. Følg en logisk rækkefølge

Det ville for eksempel ikke nytte noget at beskrive, hvordan blitzen på et kamera fungerer, før du har vist, hvordan du fastgør objektivet, indlæser filmen, tænder kameraet og justerer fokus. Dette er især nyttigt, hvis du ikke kender emnet godt.

Skriv en manual Trin 7
Skriv en manual Trin 7

Trin 3. Brug dette som din skabelon til din indholdsfortegnelse

Skriv en manual Trin 8
Skriv en manual Trin 8

Trin 4. Gennemgå dine trin

Når du har defineret de logiske sektioner, skal du gennemgå dem for at sikre, at alt er dækket.

Skriv en manual Trin 9
Skriv en manual Trin 9

Trin 5. Saml dine forsyninger

Hav de ting, du beskriver, lige ved hånden og klar til brug som beskrevet i manualen. Hvis du laver en papirkasse, skal du have papir, saks, tape, lim og en lineal lige ved hånden. Hvis du skriver om et kamera, skal du sørge for, at dit kamera er adskilt. Hvis det er muligt, skulle det produkt, du skriver om, være tilbage i kassen på dette tidspunkt.

Del 3 af 4: Start med at skrive

Skriv en manual Trin 10
Skriv en manual Trin 10

Trin 1. Skriv indledningen

Dette vil sætte tonen i hele manualen og give brugeren en idé om, hvilken slags manual de er ved at fordøje. Vil det være let og sjovt eller ligetil og uden nonsens? Det afhænger af din læserskare. Der er meget mere plads til verbal leg, der lærer børn at lave en papirkasse, end der er ved at lære en læge, hvordan de skal gå videre med operation med åbent hjerte. Fastslå tonen tidligt, og behold den tone i hele manualen.

Skriv en manual Trin 11
Skriv en manual Trin 11

Trin 2. Udfør hvert trin, mens du skriver

Dette giver ikke kun din skrivning luft af ærlighed og ægthed, du sikrer også, at intet bliver udeladt.

Hvis det af en eller anden grund ikke er muligt at udføre trinene, skal du tænke dem grundigt igennem og konsultere en, der er ekspert

Skriv en manual Trin 12
Skriv en manual Trin 12

Trin 3. Nummer trinene

Dette gør det lettere for folk at følge med, og at referere tilbage til, hvis de mister deres plads.

Hvis du skriver på papir, skal du sørge for at give plads til tilføjelser mellem hvert trin. Husk at omnummerere dine trin, hvis du tilføjer flere

Skriv en manual Trin 13
Skriv en manual Trin 13

Trin 4. Inkluder tips og advarsler

Mens du skriver, kan du indse, at hvis brugeren udfører et trin uforsigtigt, kan det forårsage et problem.

Omvendt, hvis der er en vis viden, der vil gøre brugerens opgave lettere eller mere interessant, tilføj den

Skriv en manual Trin 14
Skriv en manual Trin 14

Trin 5. Test det

Brug kun dine skriftlige instruktioner til at gøre det, du skriver om. Hvis du finder steder, hvor dine instruktioner mangler, skal du tilføje de nødvendige oplysninger. Gentag dette trin, indtil du har alle trinene og kan gøre det, du underviser uden at skulle tilføje noter.

Overvej at få en ven eller to til at bruge manualen. Se dem nøje, når de lærer at bruge produktet. Se, hvor de lyner igennem det. Se, hvor de går tabt, forvirret eller fejler opgaven. Lyt til, hvad de har at sige, og juster derefter din manual i overensstemmelse hermed

Skriv en manual Trin 15
Skriv en manual Trin 15

Trin 6. Korrekturlæs din manual

Du vil ikke sende din endelige korrekturlæser (det være sig dit bureau eller din ægtefælle) en manual fuld af klare fejl.

Del 4 af 4: Formatering

Skriv en manual Trin 16
Skriv en manual Trin 16

Trin 1. Start på øverste niveau

Når du har alle de nødvendige trin detaljeret, skal du gennemgå din manual for at finde de oplagte kategorihoveder.

Navngiv dem, og noter deres placeringer

Skriv en manual Trin 17
Skriv en manual Trin 17

Trin 2. Skriv en indholdsfortegnelse, hvis det er relevant

Se på, hvordan wikiHow er opstillet som et eksempel. Forsiden tilbyder mange sektionshoveder. Når du får adgang til et afsnit, viser det mange underkategorier, og underkategorierne viser artikler. Jo mere detaljeret din manual er, jo flere kategorier og underkategorier har du brug for. (Sådan Whistle behøver ingen, How to Carve a Whistle har brug for et par stykker, og How to Play Flute har brug for mange!)

Skriv en manual Trin 18
Skriv en manual Trin 18

Trin 3. Korrekturlæs igen

Ja, du gjorde det grundigt en gang allerede. Hvis du gør det en anden gang, vil der uden tvivl komme et par mindre fejl eller steder, hvor din manual bare ikke er klar.

For en mere omfattende manual kan du også benytte lejligheden til at notere alle de små emner og bruge disse oplysninger til at oprette et indeks

Skriv en manual Trin 19
Skriv en manual Trin 19

Trin 4. Vælg en titel

Tips

  • Selvom noget virker indlysende for dig, så skriv trinene ud! Det hjælper dig med at undgå at overskygge noget, din bruger ikke ved. Det er bedre at lægge ekstra information frem for at udelade vigtige trin.
  • Hvis du skriver en meget detaljeret manual, der kræver kapitler, f.eks. Sådan spiller du fløjte, kan dit første skridt faktisk være at liste alle kapitlerne, f.eks. Valg af fløjte, samling og pleje, toneproduktion, fingermetoder, din Første stykke osv. 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!
  • Når det er muligt, skal du illustrere dine instruktioner! Hvis du ikke kan indsætte billeder, skal du henvise din elev til noget almindeligt som eksempel. For eksempel i Formatering, trin 2 af disse instruktioner bruges udseendet af wikiHows layout til at illustrere, hvordan en indholdsfortegnelse kan oprettes.
  • Hvis du skriver hvert afsnit på en separat side (eller på en computer), bliver det lettere at redigere. Du kan lettere omarrangere, hvis du har plads til at arbejde og kan finde dine redigeringsmærker. Efterlad 3 eller 4 linjer på computeren (ved at slå gå ind flere gange) mellem hvert trin, så du nemt kan finde pauserne.
  • Hvis du kan, skal du få en nybegynder til at teste din manual og skrive ned alle spørgsmål, de stiller! Dette hjælper dig med at udfylde emnerne og gøre din manual meget mere nyttig.

Anbefalede: