Tehnilise kirjutamise põhielemendid

By | november 5, 2022

Tehniline kirjutamine on kirjutamise erivorm.

Selle eesmärk on aidata lugejatel kasutada tehnoloogiat või mõista protsessi, toodet või kontseptsiooni. Sageli on need protsessid, tooted või kontseptsioonid keerulised, kuid neid tuleb väljendada palju lihtsamas, lugejasõbralikus vormis.

Nii et tehnilise kirjutamise žanrist leiate: tehnilised aruanded, paigaldus- ja hooldusjuhendid, ettepanekud, valged raamatud, on-line abi, protsessistandardid, tööjuhised ja protseduurid.

Kuigi igal erialal on oma spetsiifilised nõuded, on mõned põhielemendid ühised. Kuid enne nende vaatamist on kõige olulisem asi, mida tehniline kirjanik peab arvestama publikuga.

Publik:

  • Kui hästi tunnevad lugejad seda teemat ning kasutatavaid eritermineid ja lühendeid?
  • Kuidas on kõige parem neid termineid või lühendatud vorme selgitada – joonealused märkused, lõpumärkused, sõnastik, lühendite tabel, lisa, lingid?
  • Kas teil on vaja kaasata teiseseid lugejaid (nt juht või rahastaja, kes ettepaneku kohta otsuse teeb) ja kuidas te seda teete?

Nüüd nende kõige olulisemate elementide kohta:

  1. Selgus – Dokumendi loogiline voog aitab lugejatel sisust aru saada. Võib olla kasulik paluda kellelgi, kes pole teemaga kursis, oma kirjutis enne selle lõpetamist üle vaadata. Pealkirjade, illustratsioonide, graafikute või tabelite kasutamine võib olla kasulik – teie eesmärk on teha lugejatele teie kirjutatust võimalikult lihtne mõista. Mõelge sellele, kuidas tekst lehel või ekraanil asetseb – see on veel üks vihje lugejate jaoks selguse maksimeerimiseks.
  2. Täpsus – Teie esitatud teave ja andmete tõlgendus peavad olema täpsed. Kui see pole nii, seavad teie lugejad kahtluse alla sisu usaldusväärsuse. Olge ettevaatlik, et selgelt eristada fakte ja arvamust ning tsiteerida täpselt viiteid teistele teostele.
  3. Lühidus – Püüdke leida tasakaal esitatud teabe hulga ja dokumendi lugemiseks kuluva aja vahel. Pidage meeles, et lisa- või taustteabe edastamiseks võite kasutada lisa või linki. Kaaluge kontseptsiooni selgitamiseks sõnade asemel illustratsiooni, tabelit või graafikut, kuid pidage meeles, et kui kasutate visuaalset, ärge andke pikka kirjalikku selgitust.
  4. Lause pikkus – Üldiselt on keerulised või võõrad mõisted kõige parem esitada lühemate lausetena. See annab lugejatele aega enne järgmise juurde asumist väikesi teabekilde seedida. Kuigi seda võib olla raske saavutada, proovige võtta eesmärgiks umbes 25 sõna lause kohta. Kui leiate, et olete kirjutanud rea pikki lauseid, otsige sõnu “ja”, “aga”, “aga” ja sarnaseid sõnu, mille abil saate lause katkestada.
  5. Lõigud – Igavene reegel ühe teema kohta lõigu kohta on kasulik juhend. See ei tähenda, et iga teema jaoks võib olla ainult üks lõik, kuid see tähendab, et igas lõigus on ainult üks teema, mis teeb selge ja loogilise kirjutamise.
  6. Lugejakesksus – Kirjutate oma lugejatele. Tehke neile teie tööst võimalikult lihtne aru saada.

Tehniliste kirjutamisülesannete täitmisel pidage neid põhielemente ja muid põhimõtteid meeles.

Lisa kommentaar

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