Wko

Hur man skriver en handbok från grunden

Skriva en manual på en viktig funktion i arbetet kan visa dina förmågor till dina överordnade. Det visar din förmåga att slutföra ett projekt på egen hand.

Steg

Hur man skriver en handbok från grunden. Besluta om ditt ämne.
Hur man skriver en handbok från grunden. Besluta om ditt ämne.
  1. 1
    Besluta om ditt ämne. Var specifik i omfattning och räckvidd.
  2. 2
    Bestäm vad målgrupp du skriver för.
    • Vill du skriva en handbok för nybörjare eller experter (eller någonstans mittemellan)?
    • Är publiken kommer att vara involverad med en klass (med manuell) eller självstudier?
  3. 3
    Definiera exakt vad du ska prata om i manualen.
    • Exempel: Du skriver en handbok "Hur man installerar Doors". En del kan handla om skjutdörrar. En annan del kan vara om framdörrarna. Ännu ett avsnitt kan vara om bakdörrar.
  4. 4
    Besluta om en logisk ordning att presentera din manual. Det handlar inte om en logisk ordning av insatser. Vissa föremål kan behöva presenteras först. Uppgifter som ska ingå i alla delar av handboken bör nog diskuteras först. Om du känner att läsaren redan borde ha kompetens att slutföra uppgiften, sedan överväga beskriver uppgiften i en bilaga.
  5. 5
    Om handboken kommer att använda tekniska termer eller jargong, förbereda en ordlista. Om det är osannolikt att läsaren redan vet jargong, placera ordlistan omedelbart efter innehållsförteckningen. Uppdatera ordlistan när du skriver manualen.
    • Definitioner av termer i denna ordlista behöver vara så exakt som möjligt. Om uttrycket är en akronym, som "Scuba", sedan helt förklara att det betyder "Slutna Underwater Breathing Apparatus" i definitionen.
  6. 6
    Bestäm vilka ämnen du behöver ytterligare forskning. En felaktig manual är en värdelös manual. Komplettera din preliminära forskning innan manualen.
  7. 7
    Besluta om en organisation för varje avsnitt du ska skriva.
    • Exempel: Du skriver en handbok om sådant och så datorn. Du har en sektion som heter "Felsökning". Du kan skriva en del av det om frågor diskutrymme. Du kan skriva en annan om överdriven minnesanvändning.
  8. 8
    Organisera varje avsnitt och underavsnitt i en logisk ordning, förträngning utbudet av ämnet.
  9. 9
    Börja skriva! Använd din organisation som en guide, men ändrar det om det inte fungerar.
    1. Skriv beskrivningar av olika arbetsuppgifter.
    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 handboken är klar. Bilderna kommer att behöva monteras på texten.
    • Ändra illustrationer för att ge tips för att indikera vad användaren är ute efter.
      1. Exempel 1: (Titta på en numrerad lista) En författare skulle ansluta ett problem med numret 13.
      2. Exempel 2: (Sortering Out) En författare skulle förstora en textrad som var i ordning.
    • 10
      Inte plagiera inte någon annans skriver! Ha en referens och / eller ett citat avsnitt böcker objekt i listan, manualer och personer som gav dig informationen.
      • Ingenting förstör en författare trovärdighet snabbare än plagiat. En dag, kan någon citera ditt skrivande. Hur skulle du känna om någon "stjäl" ditt arbete?
    • 11
      Lägg lämpliga illustrationer. Passa in dem i dokumentet. Var inte rädd för att använda vitt utrymme.
    • 12
      Korrekturläst, korrekturläsa och korrekturläsa igen. Korrekturläsning bör ske löpande. Gör anteckningar om fel eller brister. Rätta till dem. Anteckna passager andra hitta förvirrande. Skriv om passagen för att göra det lättare att läsa. Har en mängd olika människor läser din manual för att försäkra bästa möjliga resultat.
        • Detta är den ordning jag rekommenderar att du har en färdig manual korrekturläsa:
          1. Proof ditt arbete,. Dig själv
          2. Har en vän korrekturläsa det.
          3. Har en expert (på fältet du skriver om) korrekturläsa det.
          4. (Om handboken är för ditt företag), har din chef korrekturläsa det.
          5. Ha en novis korrekturläsa det.
          • Varför har korrekturläsa en nybörjare är det? Manualen ska vara begriplig för den lägsta kunskapsnivå du förväntar dig att läsa den.

          Tips

          • Kontrollera titelsidan och sidfot på varje sida du namnge som författare! Skriv ut kopior av handboken innan du skickar in elektroniskt. Har korrekturläsare göra anteckningar på sidorna. Inkludera en "c" som omges av parentes i sidfoten. De flesta program kommer att tolka denna märkning som upphovsrätt och placera rätt symbol. Den sidfoten ska läsa (c) med ditt namn. Det kommer inte att stoppa företaget från att kopiera det, men det kommer att garantera din ansökan till författarskap.