Ako načrtnúť technické dokumenty na písanie. Dobre napísaný dokument nie je vytvorený náhodou. Materiál zahrnutý v správe, manuáli alebo inom technickom dokumente je naplánovaný, usporiadaný a potom napísaný. Koncepčná fáza dokumentu je kľúčovým krokom a pravdepodobnosť, že informácie nebudú prezentované logicky, ak sa nevytvorí obrys. Objasnenie dáva autorovi príležitosť premýšľať o informáciách, ktoré by mali a nemali byť zahrnuté.
Brainstorm svoje nápady. Zapíšte si akékoľvek nápady vo vašom náčrte, o ktorých si myslíte, že by mali byť zahrnuté do technického dokumentu. Nemajte záujem o poradie informácií. Záleží len na tom, že všetky informácie sú zahrnuté do procesu brainstormingu.
Určite účel technického dokumentu. Opýtajte sa sami seba na otázku, kto číta dokument, prečo bude čítať a ako sa bude používať.
Rozhodnite sa, aký typ obrysu by ste chceli vytvoriť: historický, chronologický, špecifický pre všeobecnú, malú až veľkú, jednoduchú až komplexnú alebo akúkoľvek inú formu vhodnú pre obsah. Premýšľajte o publiku ao informáciách, ktoré chcete prezentovať. Uistite sa, že spôsob, akým sú informácie usporiadané, má najväčší zmysel pre typ predložených informácií a pre publikum, ktoré číta technický dokument.
Usporiadajte informácie v príslušnom poradí. Obrys zahŕňa zoskupenie informácií do logických sekcií a úrovní. Môžete vytvoriť hlavné témy a podtémy a podtématky.
Dokončite náčrt preskúmaním informácií, aby ste overili, či sú témy organizované vhodne a logicky. Uistite sa, že vám chýbajú žiadne kľúčové skutočnosti. Vymažte všetky informácie, ktoré nie sú relevantné pre technický dokument.
