Raamat – “Developing Quality Technical Communication”

“Developing Quality Technical Communication: A Handbook for Writers and Editors” IBM Press, 2004. Autorid: Gretchen Hargis; Michelle Carey; Ann Kilty Hernandez; Polly Hughes; Deirdre Longo;
Shannon Rouiller; Elizabeth Wilde

Minu arvamuse sellest raamatust võib kokku võtta kahe punktiga. Esiteks – see on parim raamat, mida ma tehnosuhtluse kohta olen lugenud. Ja teiseks – see ei ole kuigi hea valik esimeseks raamatuks, mida tehnosuhtluse kohta lugeda. 🙂

Kuigi need kaks kõlavad vastuoluliselt, on neil sama põhjus. See raamat on põhjalik. Esimeses peatükis pannakse paika hea dokumentatsiooni üheksa omadust ja järgnevad 10 peatükki kirjeldavad, kuidas seda saavutada. Autorid ei piirdu ainult õpetusega, kuidas dokumentatsiooni luua, vaid räägivad ka selle toimetamisest, retsenseerimisest ja testimisest. Ja kui infost väheks jääb, on iga omaduse kohta toodud ka pikk nimekiri artiklitest ja raamatutest, mida antud teemal veel võiks lugeda.

Selle raamatu järgi on heal dokumentatsioonil kolm omadust, millest igaüks koosneb kolmest osast.

  • Lihtne kasutada – ülesannetele orienteeritus, täpsus ja terviklikkus.
  • Lihtne aru saada – selgus, konkreetsus ja stiil.
  • Lihtne leida – organisatsioon, kättesaadavus ja visuaalne efektiivsus.

Iga omaduse kohta on eraldi peatükk – millest see koosneb ja kuidas seda saavutada.

Mina uurisin seda põhjalikumalt siis, kui ma hakkasin firmasisest stiilijuhendit kokku panema. Põhipunktid ja struktuur ongi pärit sellest raamatust – see on lihtsalt niivõrd efektiivne. Kahjuks ei saa kõike sellest kohe sajaprotsendiliselt rakendada, aga see on juba reaalse maailma probleem.

Lisa kommentaar

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