Kako opisati tehnične dokumente za pisanje. Dobro napisana dokumentacija ni narejena po naključju. Gradivo, ki je zajeto v poročilu, priročniku ali drugem tehničnem dokumentu, je načrtovano, organizirano in nato napisano. Izhodiščna faza dokumenta je ključni korak in možnosti so, da informacije ne bodo predstavljene logično, če okvir ni ustvarjen. Orisovanje daje avtorju priložnost, da razmisli o informacijah, ki bi morale biti in ne bi smele biti vključene.
Razmislite o svojih idejah. Zapišite si vse ideje, ki naj bi bile vključene v tehnični dokument. Ne skrbite za vrstni red informacij. Pomembno je le, da so vse informacije vključene v proces brainstorminga.
Določite namen tehničnega dokumenta. Vprašajte se, kdo bo prebral dokument, zakaj ga bodo brali in kako se bo uporabljal.
Odločite se, katero vrsto orisa želite ustvariti: zgodovinsko, kronološko, specifično za splošno, majhno do veliko, preprosto do kompleksno ali katero koli drugo obliko, ki ustreza vsebini. Razmislite o občinstvu in o informacijah, ki jih želite predstaviti. Prepričajte se, da je način, kako so informacije razporejene, najbolj smiseln glede na vrsto informacije, ki jo predstavljate, in na občinstvo, ki bo bralo tehnični dokument.
Podatke uredite v ustreznem vrstnem redu. Opis vključuje združevanje informacij v logične dele in ravni. Ustvarite lahko glavne teme in podteme in pod-teme.
Dokončajte osnutek tako, da pregledate informacije in preverite, ali so predmeti ustrezno in logično organizirani. Poskrbite, da ne boste zamudili nobenih ključnih dejstev. Izbrišite vse informacije, ki niso pomembne za tehnični dokument.
