Kaip apibūdinti techninius rašymo dokumentus

Anonim

Kaip apibūdinti techninius rašymo dokumentus. Gerai parašytas dokumentas nėra sukurtas atsitiktinai. Ataskaitoje, rankiniame ar kitame techniniame dokumente pateikta medžiaga yra suplanuota, organizuota ir parašyta. Pagrindinė dokumento stadija yra pagrindinis žingsnis ir tikimybė, kad informacija nebus pateikta logiškai, jei kontūras nebus sukurtas. Apibūdinimas suteikia autoriui galimybę pagalvoti apie informaciją, kuri turėtų ir neturėtų būti įtraukta.

Susierzinkite savo idėjas. Užsirašykite visas idėjas, kurios, jūsų manymu, turėtų būti įtrauktos į techninį dokumentą. Nesirūpinkite informacijos tvarka. Tai tiesiog svarbu, kad visa informacija būtų įtraukta į „protėvių“ procesą.

Nustatykite techninio dokumento paskirtį. Paklauskite savęs tokių klausimų, kaip kas skaitys dokumentą, kodėl jis bus skaitomas ir kaip jis bus naudojamas.

Nuspręskite, kokio tipo kontūrą norite sukurti: istorinius, chronologinius, specifinius bendrus, mažus ir didelius, paprastus sudėtingus arba bet kokią kitą turinį atitinkančią formą. Pagalvokite apie auditoriją ir informaciją, kurią norite pateikti. Įsitikinkite, kad informacijos pateikimo būdas yra labiausiai prasmingas pateikiamos informacijos tipui ir žiūrovams, kurie skaito techninį dokumentą.

Surinkite informaciją tinkama tvarka. Apibūdinimas apima informacijos grupavimą į logines sekcijas ir lygius. Galite sukurti pagrindines temas ir temas bei pogrupius.

Baigti kontūrą peržiūrėkite informaciją, kad patikrintumėte, ar dalykai yra tinkamai ir logiškai organizuoti. Įsitikinkite, kad nėra jokių pagrindinių faktų. Ištrinkite visą informaciją, kuri nėra susijusi su techniniu dokumentu.