Tehnilist kirjutamist peetakse kirjaliku suhtluse vormiks, mis sisaldab vähemalt ühte kolmest järgmisest punktist: (1) väga spetsiifilise ja tehnilise teema (nt südameoperatsiooni tulemus) kirjutamine; (2) kirjeldades, kuidas kasutada suhtlemiseks tehnoloogiat (nt veebisaidid, ajaveebid jne); või (3) protsessi või protseduuri dokumenteerimine (nt kuidas kasutada MS Excelit). Tehniline kirjutamine eeldab, et see võtab keerulise ja keerulise teema ning muudab selle mõistmise ja tõlgendamise lihtsamaks. Üks viis, kuidas tehniline kirjutamine muudab asjade mõistmise lihtsamaks, on kasutada lihtsat, otsekohese kirjutamisstiili, sealhulgas lihtsaid sõnu.
1
Tea, kelleks on teie publik. Enne mis tahes tehnilise kirjutamisprojektiga alustamist peate kõigepealt endalt küsima, kes saab teie dokumendi kasutajaks. Kas kasutajaid on mitut tüüpi? Milliseid teadmisi ja kogemusi sellel kasutajal selle teema kohta on? Milleks see kasutaja minu dokumenti kasutab? Kui sageli peavad nad minu dokumendile tagasi pöörduma? Kas kasutaja saab aru teemaga seotud žargoonist?Tehnilise kirjutamise kasutajad võivad jaguneda mitmesse erinevasse kategooriasse, millest igaühel on oma spetsiifilised vajadused: kliendid, lõppkasutajad, paigaldajad, arendajad, koolitajad ja praktikandid või tehniline tugi. ei saa iga kasutaja jaoks eraldi dokumenti kirjutada, seega peate kirjutamisel arvestama KÕIGI potentsiaalsete kasutajate vajadustega.
2
Töötage välja oma kirjutamise eesmärgid. Kui olete välja mõelnud, kes on teie sihtrühm, peate välja mõtlema, kuidas need kasutajad dokumenti kasutavad. Üldiselt jaguneb dokumendi eesmärk ühte kahest kategooriast: ülesandepõhine või viitepõhine. Ülesandepõhised dokumendid lähtuvad sellest, mida kasutaja teeb, samas kui viitepõhised dokumendid lähtuvad sellest, mida toode teeb. Ülesandepõhise dokumendi näide võib olla juhised, kuidas WordPressis veebisaiti luua. Sellises olukorras juhendate kasutaja läbi kõik sammud algusest lõpuni, olenemata sellest, kus need sammud WordPressi tarkvaras toimuvad. Viitepõhise dokumendi näide võib olla Blu-Ray-mängija kasutusjuhend. Sellises olukorras peaksite selgitama masina iga osa eraldi – mida iga nupp, funktsioon, menüüelement jne teeb.
3
Korraldage end eelnevalt. Kogu kirjutamisprotsessi kavandamine on tõhus ja tõhus viis oma projektile lähenemiseks. Hea lähenemisviis hõlmab teabe kogumist, teabe kavandamist ja korraldamist, kirjutamist, kontrollimist ja testimist ning uuesti tegemist ja ülevaatamist. Kuigi sellel lähenemisviisil on 5 puhast sammu, on see tegelikult ringprotsess. Selle lähenemisviisi igal hetkel peate võib-olla naasma eelmise sammu juurde. Teabe kogumine hõlmab järgmist: lugege teema kohta kõike, mida saate; toodet ise kasutades; mõista, mida teie kasutaja(d) peavad üksuse kohta teadma; eseme väljatöötanud inimeste küsitlemine; koosolekutel osalemine, kus teemat üksikasjalikult arutatakse, ja öeldu kuulamine; ja lubades kaubaekspertidel anda teile tagasisidet, kui teil on midagi valesti. Teabe planeerimine ja korraldamine hõlmab järgmist: selgitage välja, millest täpselt peate kirjutama (st millised on teie tulemused); oma töö ajakava koostamine; ja oma plaani ülevaatamine vajalike inimestega, et veenduda, et see vastab ootustele.Kirjutamine on kõige tõhusam järgmiselt: luua oma dokumendist täielik ülevaade, sealhulgas kõik teemad, mida kavatsete käsitleda; tegelikult iga peatüki ja lõigu välja kirjutamine; ja selle kindlaksmääramine, millal teil pole konkreetse peatüki või jaotise lõpetamiseks piisavalt teavet ja peate tegema rohkem uurimistööd. Kontrollimine ja testimine on koht, kus saate veenduda, et teie dokument teeb täpselt seda, mida see oli ette nähtud. Alustuseks proovige kasutada oma dokumenti – kas kõik sammud on loogilised, kas midagi on puudu jne. Järgmiseks lugege dokumenti sisuga mitteseotud üksuste jaoks, nagu grammatika, õigekirja, vorming jne. Lõpuks peate andma oma dokumendi ühele või mitmele eksperdile ja paluge neil see üle vaadata. Ümbertegemine ja muutmine on koht, kus saate kogu saadud tagasiside, sealhulgas endalt, ja värskendate dokumenti nende üksustega. Ja sõltuvalt sellest, kuidas dokumenti kasutatakse, võib see sisaldada pidevaid ülevaatusi ja ajakohastamist, kui dokumenti kasutatakse ja probleeme leitakse.
4
Tea juba varakult, et see ei saa olema täiuslik. Kahjuks makstakse enamikule tehnilistele kirjutajatele dokumendi koostamise eest kas kindlaksmääratud aja jooksul või kindlaksmääratud hinna eest. Võimalik, et peate tegema kompromisse ühes asjas, et tagada midagi muud. See võib tunduda karm mõte, et peast lahti saada, kuid see on paljude töökeskkondade ja -olukordade kahetsusväärne reaalsus. Kõige tähtsam on meeles pidada, et tehniline dokument peaks olema eelkõige täpne. Dokument peaks olema ka võimalikult täielik. Ei tohiks olla puuduvaid samme, mis võivad kasutajat segadusse ajada. Kui olete “täpse” ja “täieliku” osa täitnud, võite muretseda kirjavigade, vormingu, tabelite, loendite jms pärast.