Hur skriver jag en handbok från grunden?

Exempel: Du skriver en manual "Hur man installerar dörrar".

Att skriva en handbok om en viktig funktion på jobbet kan visa dina förmågor för dina överordnade. Det visar din förmåga att slutföra ett projekt på egen hand.

Steg

1

Bestäm om ditt ämne. Var specifik i omfattning och intervall.
2
Bestäm vilken publik du skriver för.
- Skriver du en handbok för nybörjare eller experter (eller någonstans däremellan)?
- Kommer publiken att delta i en klass (med hjälp av manualen) eller självstudier?
3
Definiera exakt vad du ska prata om i handboken.
- Exempel: Du skriver en manual "Hur man installerar dörrar". Ett avsnitt kan handla om skjutdörrar. Ett annat avsnitt kan handla om ytterdörrar. Ytterligare ett avsnitt kan handla om bakdörrar.
4

Bestäm en logisk ordning för att presentera din manual. Det handlar inte om en logisk åtgärdsordning. Vissa ämnen kan behöva presenteras först. Uppgifter som kommer att ingå i alla delar av handboken bör troligen diskuteras först. Om du tycker att läsaren redan ska ha färdigheterna för att slutföra uppgiften, överväg att beskriva uppgiften i en bilaga.
5
Om manualen kommer att använda teknisk terminologi eller jargong, förbered en ordlista. Om det är osannolikt kommer läsaren att känna till jargongen, placera ordlistan direkt efter innehållsförteckningen. Uppdatera ordlistan när du skriver manualen.
- Definitioner av termer i ordlistan måste vara så exakta som möjligt. Om termen är en akronym, som "Scuba", förklara helt och hållet att det betyder "Self Contained Underwater Breathing Apparatus " i definitionen.
Exempel: Du skriver en manual om en sådan dator.
6

Bestäm vilka ämnen du behöver för vidare forskning. En felaktig manual är en värdelös manual. Slutför din preliminära forskning innan du börjar manualen.
7
Bestäm en organisation för varje avsnitt du ska skriva.
- Exempel: Du skriver en manual om en sådan dator. Du har ett avsnitt som heter "Felsökning". Du kan skriva en del av den om problem med diskutrymme. Du kan skriva en annan om överdriven minnesanvändning.
8

Ordna varje sektion och underavsnitt i en logisk ordning, och begränsa ämnesområdet.
9
Börja skriva! Använd din organisation som en guide, men ändra den om den inte fungerar.
1. Skriv beskrivningar av olika uppgifter.
2. Skriv exempel som läsaren kan följa för att få instruktioner.
3. Förbered lämpliga illustrationer. Lägg inte till dem förrän manualen är klar. Illustrationerna måste anpassas till texten.
- Ändra illustrationer för att ge tips för att ange vad användaren letar efter.
  1. Exempel 1: (tittar på en numrerad lista) En författare skulle koppla ett problem med siffran "13".
  2. Exempel 2: (Sortera ut) En författare skulle förstora en textrad som inte var i ordning.
10
Plagiera inte någon annans skrivning! Ha en referens- och / eller en citatavdelning med böcker, handböcker och personer som gav dig informationen.
- Ingenting förstör en författares trovärdighet snabbare än plagiering. En dag kanske någon citerar ditt skrivande. Hur skulle du känna att någon "stjäl" ditt arbete?
Om manualen kommer att använda teknisk terminologi eller jargong, förbered en ordlista.
11

Lägg till lämpliga illustrationer. Montera dem i dokumentet. Var inte rädd för att använda vitt utrymme.
12
Korrekturläsning, korrekturläsning och korrekturläsning igen. Korrekturläsning bör pågå. Gör anteckningar om fel eller utelämnanden. Rätta dem. Anteckna passager som andra tycker är förvirrande. Skriv om avsnittet så att det blir lättare att läsa. Låt en mängd personer läsa din manual för att säkerställa bästa möjliga resultat.
- - Det här är den order jag rekommenderar att du har en fullständig korrekturläsning:
    1. Bevisa ditt arbete själv.
    2. Låt en vän korrekturläsa det.
    3. Låt en expert (inom det fält du skriver om) korrekturläsa det.
    4. (Om handboken är för ditt företag), låt din chef korrekturläsa den.
    5. Har en nybörjare korrekturläst det.
    - Varför har en novis korrekturläst det? Handboken måste vara förståelig till den lägsta kunskapsnivå du förväntar dig att läsa den.

Tips

Se till att titelsidan och sidfoten på varje sida heter DU som författare! Skriv ut kopior av handboken innan du skickar dem elektroniskt. Låt korrekturläsare göra anteckningar på sidorna. Inkludera ett "c" omgivet av parentes i sidfoten. De flesta program tolkar den märkningen som upphovsrätt och placerar rätt symbol. Sidfoten ska läsa (c) efter ditt namn. Det hindrar inte ditt företag från att kopiera det, men det garanterar ditt anspråk på författarskap.

Läs också: Hur bekämpar man återbetalningar av mastercard?