Cum se creează un manual de la zero

Scrierea unui manual despre o activitate importantă la locul de muncă vă poate demonstra abilitățile superiorilor dvs., precum și capacitatea dvs. de a finaliza un proiect pe cont propriu.

conținut

Pași
Sfaturi

pași

Imagine intitulată Scrieți un manual de la Scratch Pasul 1

Decideți asupra subiectului. Fiți concreți în ceea ce privește scopul și domeniul de aplicare.

Imaginea intitulată Scrieți un manual de la Scratch Pasul 2

Decideți cine scrieți.

Scrii pentru începători sau experți, sau chiar pentru cineva undeva între cei doi?
Vor fi cititorii folosiți manualul numai în sala de clasă sau în studiu?

Imaginea intitulată Scrieți un manual de la Scratch Pasul 3

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

Exemplu: scrieți un manual "Cum se instalează porturile". Una dintre secțiuni poate fi despre uși glisante - alta poate vorbi despre ușile de intrare - altul, chiar și pe ușile din spate.

Imaginea intitulată Scrieți un manual de la Scratch Pasul 4

Decideți asupra ordinii logice a prezentării manualului. Nu este vorba de ordinea logică a acțiunilor, ci de necesitatea prezentării unor subiecte înaintea altora. Sarcinile care vor fi incluse în toate părțile manualului ar trebui să fie discutate mai întâi - dacă simțiți că cititorul are deja capacitatea de a finaliza sarcina, luați în considerare descrierea acestuia într-o anexă.

Imaginea intitulată Scrieți un manual de la Scratch Pasul 5

Dacă manualul utilizează terminologia sau jargonul tehnic, pregătiți un glosar. Dacă este puțin probabil ca cititorul să cunoască deja limba tehnică, plasați glosarul imediat după index și actualizați-l în timp ce scrieți manualul.

Definițiile termenilor din glosar trebuie să fie cât mai exacte. Dacă termenul este un acronim, cum ar fi "BRIC", atunci trebuie să existe în definiție explicația completă că este "blocul țărilor care au în comun indicii de dezvoltare și situații similare în economie: Brazilia, Rusia, India, China și Africa de Sud. "

Imaginea intitulată Scrieți un manual de la Scratch Pasul 6

Decideți subiectele pe care trebuie să efectuați cercetări suplimentare. Un manual inexact este un manual inutil - completați căutările preliminare înainte de a începe manualul.

Imaginea intitulată Scrieți un manual de la Scratch Pasul 7

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

Exemplu: scrieți un manual despre computere. Există o secțiune numită "Depanare", unde o parte a secțiunii ar trebui să se refere la problemele legate de spațiul de pe disc și una despre utilizarea excesivă a memoriei.

Imaginea intitulată Scrieți un manual de la Scratch Pasul 8

Aranjați fiecare secțiune și subsecțiune într-o ordine logică, limitând amploarea subiectului.

Imaginea intitulată Scrieți un manual de la Scratch Pasul 9

Începeți să tastați! Utilizați organizația ca ghid, dar trebuie să o schimbați dacă nu este eficientă.

Descrieți diferitele sarcini.
Dați exemple pe care le poate citi cititorul pentru a fi instruiți.
Pregătiți ilustrațiile corespunzătoare. "Nu le adăugați până când materialul nu este complet" - ilustrațiile ar trebui să se potrivească textului.

Modificați ilustrațiile pentru a oferi sugestii și indicați ce caută cititorul.
1. Exemplul 1: (Căutați o listă numerotată) Un scriitor ar conecta o problemă la numărul "13".
2. Exemplul 2: (Mărimea potrivită) Un scriitor ar crește o linie de text care nu era în ordine.

Imagine intitulată Scrieți un manual de la Scratch Pasul 10

Nu plăgiți producțiile altor autori! Faceți o secțiune de referință și / sau citate din cărți, manuale și persoane care v-au dat informațiile.

Nimic nu distruge credibilitatea scriitorului decât plagiat. Într-un anumit moment, cineva vă poate cita munca - cum v-ați simți când cineva vă fura munca?

Imagine intitulată Scrieți un manual de la Scratch Pasul 11

Adăugați ilustrații corespunzătoare. Reglați-le la document și nu vă fie frică să utilizați blanchete.

Imaginea intitulată Scrieți un manual de la Scratch Pasul 12

Revizuiți, revizuiți și revizuiți din nou. Examinarea trebuie să fie continuă - să notați greșelile sau omisiunile și să le corectați - notați pasajele pe care "alții" le pot găsi confuz și rescrise astfel încât să fie mai ușor de citit. Citiți mai multe persoane manualul pentru a vă asigura cel mai bun rezultat posibil.

- Aceasta este comanda recomandată pentru a avea o revizuire completă a manualului dvs.:
  1. Examinați-vă singur munca.
  2. Cereți unui prieten să revizuiască manualul.
  3. Adresați-vă unui specialist (în zona în care scrieți) pentru a revedea textul.
  4. Adresați-vă șefului dvs. să-l revizuiască (dacă manualul este pentru compania dvs.).
  5. Cereți unui începător să facă recenzia.
  - De ce ar trebui să o revadă un începător? Manualul ar trebui să fie ușor de înțeles pentru cititorii cu un nivel minim de cunoștințe.

sfaturi

Asigurați-vă că pe pagina de copertă și pe subsolul fiecărei pagini se afișează numele "TU" ca autor! Imprimați copii ale manualului înainte de a le trimite în format electronic. Cereți recenzentilor să adnotați paginile și să includeți litera "c" în paranteze în subsolul paginii - majoritatea programelor vor interpreta acest semn ca marcă de drepturi de autor și vor furniza simbolul corect. Foaterul ar trebui să interpreteze (c) numele dvs. - aceasta nu va împiedica compania să copieze materialul dvs., dar vă va garanta revendicarea de autor.