Tehniline kirjutamine – kuidas vältida liialdamist ja "Hea Kirjutamine" Tehnilise kirjanikuna

By | november 7, 2022

Tehniline kirjutamine ebaõnnestub, kui see üritab muutuda “peeneks kirjutamiseks” või “loominguliseks kirjutamiseks”. Miks? Sest “peene kirjutamise” üks peamisi tööriistu on inimlike omaduste omistamine mitteinimesest näitlejatele ja agentidele. See on tehnilises dokumentatsioonis kindel tabu.

Näiteks teete selle vea iga kord, kui kirjutate lause nagu “Kui süsteem saab kasutaja valikust teadlikuks, vahetab see kanaleid.”

“Teadlikkus” on orgaanilise (inimese, looma või isegi taime) teadvuse atribuut. Masinad ja arvutisüsteemid ei ole millestki “teadlikud” nii, nagu meie, inimesed, asjadest teadlikud oleme.

Parem lause oleks: “Kui süsteem tuvastab kasutaja valiku, vahetab see kanaleid.” Siin ei ole väidet, et “süsteem” on “elus” koos “teadvusega”.

Sama “peene kirjutamise” viga tehakse siis, kui tehniline kirjanik kasutab omadussõnu, ülivõrdeid ja joonistab tehnilistest olekutest ja protsessidest liialdatud pildi.

Näiteks võib romaanis olla kooskõlas “poeetilise litsentsiga” rääkida “ilusast granaatõunavärvi punasest märgutulest”, mis süttib, kui kasutaja vajutab nuppu OFF. Kuid tehnilises dokumendis on selline liialdatud kirjeldus naeruväärne.

Parem kirjeldus oleks “punane märgutuli süttib, kui kasutaja vajutab OFF nuppu”. See on lihtne, õige ja tõhus.

Jällegi: “Kui kuulete B-moodulist kostvat kohutavat heli, on aeg õli vahetada.” Omadussõna “kohutav” ei kuulu tehnilisse kirjutamisse, kuna selle tähendus on subjektiivne ja võib ühelt inimeselt teisele muutuda. Tehniline dokument peab olema võimalikult objektiivne, et välistada kõik rakenduses esinevad muudatused.

Parem lause oleks: “Kui kuulete B-moodulist kostvat kõrget heli, on aeg õli vahetada.”

Lisa kommentaar

Sinu e-postiaadressi ei avaldata. Nõutavad väljad on tähistatud *-ga