Cum se scrie un manual

Scrierea unui manual de instrucțiuni poate părea o sarcină dificilă, dar este mai ușor decât crezi! Aceste etape sunt aplicabile oricărei instrucțiuni de scriere, de la cele mai simple (cum a învățat bate din palme), chiar și cele mai complicate (Cum de a construi un semi-conductor).

conținut

Pași
Metoda 1cunoaște subiectul
Metoda 2planificați aspectul manualului
Metoda 3Începeți să tastați
Metoda 4formatarea
Sfaturi

pași

Metoda 1
Cunoaște subiectul

1
Aceasta este cheia. Poate părea destul de evident, dar cunoașterea este cheia pentru a scrie un manual de succes. De exemplu, dacă scrieți manual pentru un aparat de fotografiat, știu că abertuda și viteza de declanșare nu sunt două funcții separate - chiar dacă acestea sunt - dar știind modul în care acestea interacționează între ele face mult mai ușor de descris fiecare funcție și modul în care se referă la întreg.
2
Discutați cu specialiștii. Dacă rolul dvs. este pur și simplu de a scrie și de a nu fi un expert pe această temă, implicați oameni în proces care știu bine despre ceea ce scrieți și asigurați-vă că vă revizuiesc activitatea. În acest domeniu, cunoștințele și sfaturile sunt neprețuite.
3
Încercați o abordare practică. Dacă este posibil, a face ceea ce scrieți va oferi cel puțin o idee despre ceea ce utilizatorul va dori să învețe.
4
Citiți despre asta. Învață să vorbești și să te familiarizezi cu produsul despre care scrii.
- Manualele sau alte produse similare vă vor arăta cum ceilalți scriitori au abordat subiectul.
  - Căutați asemănări între scriitori, ceea ce indică atât o funcționalitate comună, cât și o abordare comună atunci când descrieți ceva.
  - Căutați diferențe care ies în evidență. Este posibil ca acestea să fie funcții unice pentru un anumit produs. Produsul dvs. poate sau nu să fie inclus în aceste funcții sau pot avea modalități alternative de a rezolva problema pe care o puteți scrie, mărind valoarea produsului dvs. Atâta timp cât treaba este de a scrie un articol despre cum să faceți ceva, arătând clienților valoarea achiziției dvs. este o modalitate foarte bună de a le încuraja să continue să le citească.
- Devour reviste de produse. Aflați cum oamenii care folosesc produsele lucrează cu ei zilnic. Aceștia ar putea dori o funcție pentru a rezolva o anumită problemă, iar dacă produsul dvs. este soluția, trebuie să fie evidențiat.

Metoda 2
Planificați aspectul manualului

1
Separați lucrurile. Fie că este vorba despre o foaie simplă, cu un ghid pas cu pas sau un manual pentru o cameră digitală de 35 mm, separarea textelor în bucăți mici are câteva avantaje:
- Vă permite să vă concentrați asupra părților individuale ale unui întreg. Scopul său este de a familiariza utilizatorul cu procesul de învățare al manipulării produsului. Învățați funcționalitatea produsului trebuie lăsat într-un tutorial la sfârșitul ghidului dacă doriți sau lăsați-l pe utilizatorul să afle singur.
2
Urmați o secvență logică. Ea nu ajută, de exemplu, descrie modul în care funcționează blițul unui aparat de fotografiat până când nu au arătat cum să pună lentila, încărcați filmul, porniți aparatul foto și reglați focalizarea. Acest lucru este foarte util dacă nu cunoașteți subiectul foarte bine.
3
Utilizați acest lucru ca șablon pentru indexul dvs.
4
Examinați pașii. Odată ce ați definit secțiunile logice, revizuiți-le pentru a vă asigura că acoperiți totul.
5
El și-a adunat bunurile. Obțineți elementele pe care le descrieți în mână și le lăsați gata de utilizare așa cum este descris în manual. Dacă creați o cutie de hârtie, aveți în mână hârtie, foarfece, bandă, clei și o riglă. Dacă scrieți despre o cameră foto, asigurați-vă că camera dvs. este demontată. Dacă este posibil, produsul pe care îl descrieți ar trebui să fie deja înapoi în cutie în acest moment.

Metoda 3
Începeți să tastați

1
Scrie introducerea. Acest lucru va determina tonul întregului manual și va oferi utilizatorului o idee despre ce fel de manual este pe cale să citească. Este ușoară și distractivă sau este directă și lipsită de sens? Depinde de fuga ta. Există mult mai mult spațiu pentru a juca cu cuvinte atunci când îi învață pe copii cum să creeze o cutie de hârtie decât atunci când încearcă să-i învețe pe doctor ce să facă în chirurgia toracică deschisă. Setați tonul mai devreme și păstrați-l pe tot textul.
2
Realizați fiecare pas în timp ce scrieți. Nu numai că va da scrisului dvs. un aer de onestitate și autenticitate, dar va asigura, de asemenea, că nu ați uitat nimic.
- Dacă dintr-un anumit motiv nu puteți urma pașii, gândiți-vă complet la ele și consultați pe cineva care este expert.
3
Numărați pașii. Acest lucru face mai ușor pentru oameni să urmeze pașii și apoi să revină mai târziu dacă se pierd.
- Dacă scrieți pe hârtie, asigurați-vă că vă lăsați mai mult spațiu pentru a face adăugări între fiecare pas. Nu uitați să renumerabați pașii dacă ați adăugat un alt pas între ele.
4
Includeți sfaturi și avertismente. Pe măsură ce scrieți, puteți constata că dacă urmați unul dintre pași fără griji, poate duce la o problemă.
- Pe de altă parte, dacă există alte cunoștințe care vor face sarcina utilizatorului mai ușoară sau mai interesantă, adăugați acele cunoștințe.
5
Testul. Folosind doar instrucțiunile dvs. scrise, faceți ceea ce ați scris. Dacă găsiți locuri unde instrucțiunile sunt incomplete, adăugați informațiile necesare. Repetați acest pas până când aveți toate pașii și puteți face ceea ce predați fără să faceți note.
- Luați în considerare întrebarea dacă unul sau doi prieteni vor citi manualul. Uită-te atent când învață să folosească produsul. Vezi dacă pot completa manualul. Vedeți unde se pierd, se confundă sau eșuează în timp ce încearcă să finalizeze sarcina. Ascultați ce au de spus și apoi faceți ajustările conform comentariilor.
6
Consultați manualul. Nu doriți să trimiteți recenzorului final (fie o agenție, fie soția dvs.) un manual plin de greșeli greșite.

Metoda 4
formatarea

1
Începeți la cel mai înalt nivel. După ce ați detaliat toate pașii, consultați manualul dvs. și căutați anteturile pentru categorii.
- Îndemnați-i și scrieți locațiile lor.
2
Scrieți un index, dacă este cazul. Uită-te la modul în care wikiHow este aranjat, de exemplu. Pagina principală oferă vizitatorului titlurile secțiunilor. Când accesați o secțiune, veți găsi o listă de subcategorii și apoi în categoriile pe care le găsiți o listă de articole. Cu cât manualul dvs. este mai detaliat, cu atât mai multe categorii și subcategorii veți avea nevoie.
3
Verificați din nou. Da, ați examinat o dată toate materialele. Făcând-o din nou sigur vă va face să găsiți câteva bug-uri sau locuri minime în manualul dvs. care nu sunt atât de clare încă.
- Pentru un manual mai cuprinzător, puteți utiliza, de asemenea, această ocazie pentru a scrie toate subiectele mai mici și pentru a le utiliza pentru a crea un index.
4
Alegeți un titlu.

sfaturi

Dacă scrieți un manual foarte detaliat care necesită capitole, cum ar fi un manual care învață Cum se joacă fluierul, trebuie să listați mai întâi toate capitolele, cum ar fi Alegerea unui flaut, montaj și îngrijire, producție de sunet, metode de a juca, prima dvs. flaut, etc. Doar atunci trebuie să aplicați regulile de bază ale unui manual pentru fiecare capitol, deoarece fiecare dintre ele este ca un manual separat!
Chiar dacă vă pare ceva evident, scrieți pașii! Vă va ajuta să nu treceți peste ceva pe care utilizatorul nu îl cunoaște. Este mai bine să aveți informații suplimentare decât să lăsați la o parte pași importanți.
Ori de câte ori este posibil, ilustrați instrucțiunile! Dacă nu puteți introduce imagini, dați studentului dvs. un exemplu. De exemplu, în Formatarea, Pasul 2 din acest articol, apariția aspectului WikiHow este folosită pentru a ilustra modul în care poate fi creat un index.
Dacă este posibil, cereți unei persoane care nu are experiență în zonă să citească manualul și să scrie orice întrebare are! Acest lucru vă va ajuta să completați semnele și să vă faceți manualul mult mai util.
Scrierea fiecărei secțiuni pe o pagină separată (sau pe un computer) face mai ușoară editarea. Puteți rearanja cu ușurință dacă aveți loc de lucru și puteți găsi marcajele de editare. Pe un computer, lăsați 3-4 linii (apăsând introduce de mai multe ori) între fiecare pas, astfel încât să puteți găsi pauzele.

Distribuiți pe rețelele sociale:

înrudit