Cum să evidențiați documentele tehnice de scriere. Un document bine scris nu este creat întâmplător. Materialul acoperit într-un raport, manual sau alt document tehnic este planificat, organizat și apoi scris. Etapa de elaborare a unui document este un pas cheie și sunt șanse ca informațiile să nu fie prezentate logic dacă nu este creată o schiță. Descrierea oferă autorului șansa să se gândească la informațiile care ar trebui și nu trebuie incluse.
Creați-vă ideile. Scrieți ideile din conturul pe care credeți că ar trebui incluse în documentul tehnic. Nu vă îngrijorați de ordinea informațiilor. Este important faptul că toate informațiile sunt incluse în procesul de brainstorming.
Determinați scopul documentului tehnic. Puneți-vă întrebări cum ar fi cine va citi documentul, de ce va fi citit și cum va fi folosit.
Decideți ce tip de contur doriți să creați: istoric, cronologic, specific general, mic până la mare, simplu până la complex sau orice altă formă corespunzătoare conținutului. Gândiți-vă la public și la informațiile pe care doriți să le prezentați. Asigurați-vă că modul în care informațiile sunt aranjate face cel mai mult sens pentru tipul de informații prezentate și pentru publicul care va citi documentul tehnic.
Aranjați informațiile în ordinea corespunzătoare. O schiță implică gruparea informațiilor în secțiuni și niveluri logice. Puteți crea subiecte și sub-sub-subiecte principale.
Finalizați conturul examinând informațiile pentru a verifica dacă subiecții sunt organizați corespunzător și logic. Asigurați-vă că nu lipsesc fapte cheie. Ștergeți orice informație care nu este relevantă pentru documentul tehnic.
