Tehnilise kirjutamise ABCS – 4 funktsiooni, mida tehnilised kirjutajad peavad teadma

By | november 3, 2022

Tehnilise aruande kirjutamine on paljudele tehnikaspetsialistidele sageli tõeline väljakutse. Uurimine, uurimine või disain on põhjus, miks te teete seda, mida teile meeldib teha… aga siis peate kirjutama aruande. Ja see võib olla nõrk lüli. Kuid mõned tehnilise kirjutamise funktsioonid on olulised, olenemata teie valdkonnast või organisatsioonist. Mulle meeldib neid meenutada tehnilise kirjutamise ABCS-ina: täpsus, lühidus, selgus ja lihtsus.

  1. Täpsus: teie leidude täpne aruandlus; faktide täpne esitamine; teie leidude täpne esitus vastavalt teie kasutatud meetoditele. Märkige selgelt, kus olete oma arvamust avaldanud, mitte uurimise teatud tulemuse. Võimaluse korral andke üldistuste asemel konkreetset teavet.
  2. Lühidus: Püüdke dokument hoida võimalikult lühike – ajavaesed lugejad hindavad seda. Kaaluge tausta- ja tugiteabe lisamist, joonealust märkust või lõpumärkuse viidet. Nii palju kui võimalik, hoidke laused lühikesed (15–20 sõna sobib enamikule lugejatest hästi), igas lauses väljendatakse ainult ühte mõtet.
  3. Selgus: Kasutage tuttavat sõnavara ja konstruktsioone (veenduge, et olete mõelnud, kes teie aruannet loeb, ja olge valmis seletama potentsiaalselt võõraid sõnu, võib-olla sõnastiku, joonealuse või lõpumärkusena). Olge järjekindel oma terminoloogia, lühendite ja jooniste, tabelite, illustratsioonide jms esitusega. Kaaluge oma mõtte demonstreerimiseks tabeleid, jooniseid, graafikuid, illustratsioone… nagu nad ütlevad, säästab pilt tuhat sõna. Pidage meeles, et žargoon (teie valdkonnas kasutatavad eriterminid) välistab need, kes neid sõnu ei tunne. Kasutage täpseid sõnu: teie lugejad ei hinda, et nad peavad otsustama, kas sõnal on erinevates kontekstides veidi erinev tähendus. Kasulik tehnika on kasutada keeruliste ideede väljendamiseks täppe või nummerdatud punkte (kui teie distsipliin või organisatsioon seda võimaldab).
  4. Lihtsus: See tähendab oma mõtete väljendamist lihtsusega, mitte töö lihtsustamist. Pidage meeles oma lugejaid: soovite näidata neile oma töö väärtust, mitte seda, kui hea kirjanik te olete. Sisu on tähtsam kui ekstravagantne kirjutis. Paljusõnalisus takistab teie lugejate arusaamist. Veenduge, et olete mõelnud oma aruande loogilisele edenemisele. Planeerige oma dokumendi struktuur nii, et viiksite lugejad järeldusele, milleni olete jõudnud. Lihtsus, mis on omane lihtsa inglise keele kasutamisele (aktiivne hääl, mõistlik lause pikkus, spetsialiseeritud terminite tark kasutamine, ilma paljusõnalisuseta) on teile kasulik.

Tutvuge tehnilise kirjutamise ABCS-iga. Pidage meeles, et kirjutate selleks, et teie lugejad ütleksid: “See on suurepärane töö”, mitte “See on hea kirjutis, aga ma pole tõesti kindel, milles see oli.”

Lisa kommentaar

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