Cum de a scrie un manual de la zero

Scrierea unui manual despre o funcție importantă la locul de muncă demonstrează abilitățile dumneavoastră superiorilor. Arătați-vă abilitățile pentru a finaliza un proiect pe cont propriu.

2

Decideți ce tip de audiență scrieți.

3

Definiți exact ceea ce veți vorbi în manual.

4

Decideți-vă o ordine logică pentru a vă prezenta manualul. Aceasta nu se referă la o ordine logică a acțiunilor. Este posibil ca unele subiecte să fie prezentate mai întâi. Trebuie explicate mai întâi activitățile care trebuie incluse în toate părțile manualului. Dacă simțiți că cititorul ar trebui să aibă deja abilități pentru a finaliza sarcina, atunci luați în considerare descrierea sarcinii într-o anexă.

5

Dacă manualul va folosi terminologia sau jargonul tehnic, pregătiți un glosar. Dacă credeți că este puțin probabil ca cititorul să cunoască terminologia, plasați glosarul imediat după cuprins. Actualizați glosarul în timp ce scrieți manualul

6

Decideți la ce probleme trebuie să faceți o investigație mai aprofundată. Un manual greșit este un manual inutilizabil. Finalizați investigația preliminară înainte de a începe manualul.

7

Decideți cu privire la organizarea fiecărei secțiuni pe care o veți scrie.

8

Organizați fiecare secțiune și subsecțiune într-o ordine logică, reducând amplitudinea subiectului.

9

Începeți să scrieți! Utilizați organizația ca ghid, dar modificați-o dacă nu funcționează.

• Modificați ilustrațiile pentru a oferi sugestii pentru a indica ce caută utilizatorul.
  
• Exemplul 1: (Privind o listă listată) Un scriitor ar conecta o problemă cu numărul "13".
  
• Exemplul 2: (Clasificarea) Un scriitor ar prelungi o linie de text care nu a fost de ordine.

10

Nu plătiți scrisul altcuiva! Aveți o listă de referințe și / sau citate din cărți, manuale și persoane care v-au dat informațiile.

11

Adăugați ilustrații corespunzătoare. Reglați-le în document. Nu vă fie teamă să folosiți spațiu alb.

12

Remediați, corectați și corectați din nou. Corecția trebuie să fie continuă. Efectuați note de erori sau omisiuni. Corectați-le. Faceți note de pasaje pe care "alții" le pot găsi confuz. Rescrieți pasajul pentru a facilita citirea. Aveți o varietate de persoane care vă citesc manualul pentru a vă asigura cel mai bun rezultat posibil.

• De ce să-l corectezi un începător? Manualul trebuie să fie ușor de înțeles pentru un nivel minim de cunoștințe pe care vă așteptați să îl citiți.