Teknisten kirjoitusasiakirjojen ääriviivat. Hyvin kirjoitettu asiakirja ei ole luotu sattumalta. Raportin, käsikirjan tai muun teknisen asiakirjan sisältämä materiaali on suunniteltu, järjestetty ja sitten kirjoitettu. Asiakirjan esitysvaihe on keskeinen askel ja mahdollisuudet, että tietoja ei esitetä loogisesti, jos ääriviivat eivät ole luotu. Suunnittelu antaa tekijälle mahdollisuuden ajatella tietoja, joita pitäisi ja ei pitäisi sisällyttää.
Ajattele ideoita. Kirjoita kaikki ajatukset, jotka sinun mielestänne tulisi sisällyttää tekniseen asiakirjaan. Älä huolehdi tietojen järjestyksestä. Se on vain se, että kaikki tiedot sisältyvät aivoriihi-prosessiin.
Määritä teknisen asiakirjan tarkoitus. Kysy itseltäsi sellaisia kysymyksiä, kuten mitä asiakirja lukee, miksi se luetaan ja miten sitä käytetään.
Päätä, millaista ääriviivaa haluat luoda: historialliset, kronologiset, yleiset yleiset, pienet ja suuret, yksinkertaiset ja monimutkaiset tai muuhun sisältöön sopivaan muotoon. Ajattele yleisöä ja tietoja, joita haluat esittää. Varmista, että tiedot järjestetään parhaiten esitettävien tietojen tyypille ja yleisölle, joka lukee teknistä asiakirjaa.
Järjestä tiedot sopivaan järjestykseen. Yhteenveto sisältää tietojen ryhmittämisen loogisiin osiin ja tasoihin. Voit luoda keskeisiä aiheita ja aliteemoja ja osa-alaaiheita.
Viimeistele ääriviiva tarkistamalla tiedot, jotta aiheet on järjestetty asianmukaisesti ja loogisesti. Varmista, että et ole puuttunut keskeisistä tosiseikoista. Poista kaikki tiedot, jotka eivät liity tekniseen asiakirjaan.
