Kako opisati tehničke dokumente za pisanje. Dobro napisana dokumentacija nije stvorena slučajno. Materijal koji je obuhvaćen izvješćem, priručnikom ili drugim tehničkim dokumentom planira se, organizira i zatim napiše. Nacrt dokumenta je ključni korak i šanse su da informacije neće biti predstavljene logično ako se ne izradi nacrt. Opisivanje daje autoru priliku da razmisli o informacijama koje bi trebale i ne bi trebale biti uključene.
Razmislite o svojim idejama. Zapišite bilo koje ideje u svom nacrtu za koje mislite da bi trebale biti uključene u tehnički dokument. Ne brinite o redoslijedu informacija. Samo je važno da su sve informacije uključene u proces brainstorminga.
Odredite svrhu tehničkog dokumenta. Postavite sebi pitanja poput toga tko će čitati dokument, zašto će se čitati i kako će se koristiti.
Odlučite koju vrstu nacrta želite stvoriti: povijesnu, kronološku, specifičnu za opće, malu ili veliku, jednostavnu do složenu ili bilo koji drugi oblik prikladan sadržaju. Razmislite o publici i o informacijama koje želite predstaviti. Pobrinite se da način na koji su informacije raspoređene ima najviše smisla za vrstu informacija koje se prezentiraju i za publiku koja će čitati tehnički dokument.
Organizirajte informacije u odgovarajućem redoslijedu. Skica uključuje grupiranje informacija u logičke dijelove i razine. Možete stvoriti glavne teme i pod-teme i pod-teme.
Završite nacrt tako da pregledate informacije kako biste provjerili jesu li subjekti organizirani na odgovarajući i logičan način. Pobrinite se da ne propuštate nikakve ključne činjenice. Izbrišite sve informacije koje nisu relevantne za tehnički dokument.
