Tehniline kirjutamine on kirjutamine, mis kirjeldab või selgitab lugejale toodet, teenust või ideed. Kuigi tehnilisel kirjutamisel on essee kirjutamise ja ajakirjandusega ühiseid elemente, eristub see mõlemast. Tehnilist kirjutamist saab õppida tööl, kuid seda õpetatakse sagedamini kolledži tundides ja seminaridel. Tehnilise kirjutamise õpetamine hõlmab õpilastele selle tähtsuse, toodetavate dokumentide tüüpide ja eesmärkide õpetamist, mille poole tehnilised kirjutajad püüdlevad. Järgmised sammud hõlmavad neid aspekte.
1
Õpetage õpilastele tehnilise kirjutamise tähtsust. Õpilased peavad mõistma nii seda, kui oluline on kirjutamine nende karjääris, kui ka seda, kui oluline on, et nad kirjutaksid hästi. Madala tasemega töötajad võivad eeldada, et nad kulutavad kuni 20 protsenti oma ajast kirjutamisele, kusjuures kirjutamisele kuluva aja protsent suureneb nad ronivad ettevõtte redelil. Nagu tsiteerib Janet Van Wicklen raamatus “Miks Dick ja Jane ei saa tööl kirjutada”, kaotavad Ameerika ettevõtted igal aastal rohkem kui 1 miljard dollarit halvasti kirjutatud suhtluse tõttu.
2
Tutvustage õpilasi erinevate dokumentidega, mida tehnilised kirjutajad koostavad. Tehnilise kirjutamise saab jagada mitmeks alamtüübiks, nagu allpool kirjeldatud. Mõnes dokumendis võib olla rohkem kui ühe alamtüübi elemente, näiteks turundusega seotud teemad spikrifailis. Õpetuste kirjutamine: see hõlmab õpikuid, kasutusjuhendit ja omaniku käsiraamatuid, tarkvara abifaile, protseduuride juhendeid ja juhendartikleid. . Õpetusliku kirjutamise eesmärk on teavitada, selgitada ja harida. Turunduskirjutamine: see hõlmab lendlehti, brošüüre, väliseid uudiskirju, sotsiaalmeedia postitusi ja valgeid pabereid. Kui turundusliku kirjutamise eesmärk on müüa sama palju kui teavitada, siis turunduseesmärkidel kasutatav tehniline kirjutamise stiil on selline, mis teavitab, müüa varjatud veenmise asemel jutustades.Ärikommunikatsioon: see hõlmab ettevõttesiseseid uudiskirju, kirju, aruanded, ettevõtte memod, ettevõtte sisevõrgud ja meilid. Ärisuhtluse eesmärk on edastada ettevõtte poliitikat, plaane ja edusamme neile, kes on ettevõtte edu vastu kas töötajate või investoritena huvitatud.
3
Püüdke selguse poole. Tehniline kirjutamise sisu peaks seda lugevale inimesele selgelt aru saama. Halvasti kirjutatud sisu võib põhjustada seadmete katki, asenduskulusid ja võib-olla omaniku vigastuse või ettevõtte kohtusse kaevamise, mis kõik võib kahjustada suhtekorraldust. Üks viis selguse tagamiseks on kasutada mitmetähenduslike mõistete asemel kindlaid koguseid: selle asemel “kolm” “mitu”, “iga nelja tunni järel” sõna “sageli” asemel, “nädal tagasi” asemel “hiljuti” ja nii edasi. Teine viis selguse tagamiseks on kasutada antud sõna, mis esindab sama mõistet kogu dokumendis . Näiteks tarkvara abifailis peaks “ekraan” viitama alati arvutiekraanile, “aken” peaks alati viitama tarkvararakenduse põhikuvale ja “dialoog” või “dialoogikast” peaks viitama mis tahes ujuvale osale. ekraanil, mis palub kasutajal vastata.
4
Olge lühidalt. Erinevalt teistest kirjutamisviisidest on tehniline kirjutamine mõeldud selleks, et aidata lugejal saavutada eesmärki, sageli piiratud aja jooksul. Sel põhjusel kasutab tehniline kirjutamine oma mõtte väljendamiseks nii vähe sõnu, kui on vaja. Mõned tehnilised dokumendid on nende ülesehituse tõttu lühikesed. Auto kasutusjuhend on kirjutatud lühidalt, kuna see on mõeldud kindalaekasse mahtumiseks, samas kui käekella kasutusjuhendid on sageli koostatud nii, et need mahuksid käekella korpusesse. Interneti tehniline kirjutamine peab olema lühike, sest paljudel lugejatel on see raskem teksti lugeda ekraanilt kui trükituna. Samuti tähendab tahvelarvutite ja nutitelefonide tulek seda, et paljud lugejad loevad laua- või sülearvutite ekraanidest väiksema ekraaniga. Üks võimalus lühidalt olla on kasutada lühimat sõna, mis kontseptsiooni edasi annab: “kasuta” “kasutama”, “proovima” asemel “püüdma”, “to” asemel “et teha”. Eessõnalised fraasid võib sageli asendada ühe omadussõnaga nimisõna ees või täielikult välja jätta. Teine viis olla lühike, on mittevajalikud sõnad välja jätta. Midagi on unikaalne; see ei ole “mõnevõrra ainulaadne”, “pigem ainulaadne” või “väga ainulaadne”. Kolmas viis lühidalt on kasutada võimalusel passiivse hääle asemel aktiivset häält. Aktiivne hääl kasutab tegevusverbe ilma tegusõnu sidumata (“Tehniline kirjutamine kasutab nii vähe sõnu kui vaja”), passiivne hääl aga seob verbe, nagu “on” või “oli” tegusõnade osastava vormiga (“Auto kasutusjuhendis on kirjutatud lühidalt “).
5
Paigutage dokument hõlpsaks lugemiseks. Tehniline kirjutamine paneb rohkem rõhku sellele, kuidas sisu on lehel või ekraanil paigutatud, kui muud kirjutamisviisid. Eesmärk on esitada teavet nii, et seda saaks kiiresti lugeda ja mõista. Tehnilistes dokumentides võib kasutada mõnda või kõiki järgmisi abivahendeid:graafika, nagu illustratsioonid, fotod ja tabelid.valge tühik suuremate veeriste ja ploki taande kujul olulise teksti tuvastamiseks.Pealkirjad ja alampealkirjad järgmiste lõikude mõistete tuvastamiseks neid. Erinevad kirjasuurused ja tüübid. Pealkirjad ja alampealkirjad kasutavad tavaliselt suuremat punkti suurust kui põhitekst ja võivad erineda põhitekstist. Fontide vormindamine, näiteks paksus kirjas, allajoonimisel ja kaldkirjas. Neid kasutatakse sageli järjekindlalt rõhutamiseks, näiteks tarkvara kasutajaliideste virtuaalsete nuppude nimed kirjutatakse paksus kirjas.Täpploendid ja nummerdatud loendid. Täpploendid rõhutavad sageli põhipunkte, samas kui nummerdatud loendid loetlevad sageli protseduuri järgimise etapid.
6
Tunne oma publikut. Kui teate, kes teie kirjutatavat dokumenti loeb, mõjutab see, milliseid sõnu valite selguse ja lühiduse huvides, ning võib määrata ka dokumendi paigutuse. Vaatajaskondi võib laias laastus kirjeldada kui ühte kolmest tüübist: kõrgtehnoloogilised kolleegid / aineeksperdid. Need lugejad teavad teemast üldiselt sama palju kui kirjutaja. Keegi, kes kirjutab sellele vaatajaskonnale, võib kasutada selle teemaga seotud žargooni ilma seda selgitamata.Madaltehnoloogilised kolleegid/teadlikud inimesed. Need lugejad teavad teemast midagi, kuid mitte nii palju kui kirjanik. Sellele vaatajaskonnale kirjutav inimene võib kasutada teemaga seotud kõnepruuki, kui seda õigesti selgitatakse. Tavalised lugejad/lõppkasutajad. Need lugejad on kliendid, kliendid, patsiendid või keegi teine väljaspool ettevõtet. Sellele vaatajaskonnale kirjutav inimene peaks vältima žargooni ja eelistama sõnu, mida kasutatakse selle žargooni selgitamiseks madala tehnoloogiaga kolleegidele, ja võib-olla peab lisama ka täiendava selgituse.
7
Ole täpne. Tehniline kirjutis peab andma lugejale õiget, õigesti kirjutatud teavet. Esitatud faktid peavad olema õiged, igasugune matemaatika ja kasutatav grammatika peab olema õige, et lugeja keskenduks sisule, ilma et teda vead segaksid. Enamikku tehnilisi kirjutisi tuleb uurida samal viisil kui kolledži esseesid. andmete uurimine, ekspertide küsitlemine ning anekdootide ja näidete leidmine.