A műszaki írási dokumentumok vázlata. Egy jól megírt dokumentumot nem véletlenszerűen hoztak létre. A jelentésben, a kézikönyvben vagy más műszaki dokumentumokban szereplő anyagokat tervezik, szervezik és írják. A dokumentum vázlatos szakasza kulcsfontosságú lépés, és az esélye, hogy az információ logikailag nem kerül bemutatásra, ha egy vázlatot nem hoz létre. A vázlatok lehetőséget adnak a szerzőnek arra, hogy gondolkodjanak az információkról, amelyeket be kell tartani és nem kellene belefoglalni.
Brainstorm az ötleteket. Jegyezze fel a vázlatban szereplő ötleteket, amelyeket úgy gondolja, hogy bele kell foglalni a műszaki dokumentumba. Ne aggódjon az információk sorrendjével. Csak annyit jelent, hogy az összes információ szerepel az ötletgyűjtési folyamatban.
Határozza meg a műszaki dokumentum célját. Kérdezd meg magadtól olyan kérdéseidet, mint a ki fogja olvasni a dokumentumot, miért fog olvasni, és hogyan fogja használni.
Döntse el, hogy milyen típusú vázlatot szeretne létrehozni: történelmi, kronológiai, általános, kicsi vagy nagy, egyszerű, bonyolult vagy bármilyen más, a tartalomnak megfelelő forma. Gondolj a közönségre és a bemutatni kívánt információkra. Győződjön meg róla, hogy az információ elrendezése a leginkább értelme a bemutatott információk típusának és a közönségnek, aki elolvassa a műszaki dokumentumot.
Rendezze az információkat a megfelelő sorrendben. A vázlat magában foglalja az információk logikai szakaszokra és szintekre történő csoportosítását. Létrehozhat főbb témákat és al-témákat és al-al-témákat.
Végezze el a vázlatot az információk áttekintésével, hogy ellenőrizze, hogy a témák megfelelően és logikusan vannak-e szervezve. Győződjön meg róla, hogy nincsenek semmilyen fontos tény. Töröljön minden olyan információt, amely nem releváns a műszaki dokumentumban.
