Optimaalne dokumentatsioon. Kasulik, ajakohane ja mugav

Raamatu eesmärk on aidata saavutada dokumenteerimisel tasakaal: luua kasulikku ja ajakohast dokumentatsiooni, mis pole üleliigselt koormav ega liialt aeganõudev, vaid on mugav kasutada, luua ning hallata.

Raamat on mõeldud kõigile, kes soovivad saada inspireeritud dokumenteerimisest, eelkõige aga neile, kes juba tegelevad dokumenteerimisega. Räägin eelkõige põhimõtetest, aga toon ka näiteid. Kuna minu kogemus on eelkõige IT-projektidest, siis näited ja soovitused on just sellest valdkonnast. Samas usun, et taolisest materjalist on kasu ka nendel, kes dokumenteerivad midagi muud kui IT-projekte. Huvi korral saab põhimõtteid rakendada kõikvõimalikes valdkondades ja kontekstides, kus on oluline, et dokumentatsioon oleks kasulik, optimaalne, ajakohane ja mugav.

Raamat on jaotatud viieks osaks, mis pakuvad samm-sammulise teekonna dokumentatsiooni loomise, haldamise ja ajakohastamise kohta.

1. Kasulik: Alustame sellest, et luua arusaamise eelkõige enda sees, et dokumentatsioon on tõesti kasulik.

2. Optimaalne: Teeme valiku vajalikust dokumentatsioonist vastavalt projekti suurusele ja dokumentatsiooni sihtrühma vajadustele. Kirjutame dokumentatsiooni selliselt, et see oleks kergesti mõistetav.

3. Ajakohane: Vaatame oma tööprotsesse ja millal me dokumentatsiooni loome ja uuendame, et see oleks alati ajakohane.

4. Mugav: Teeme dokumentatsiooni loomise, lugemise ja haldamise mugavaks, kasutades struktuuri ja tööriistade võimalusi.

5. Sinu dokumentatsioon: Lõpuks räägime sellest, kuidas kõik need eelnevad põhimõtted kokku käivad, kuidas sellest raamatust loetut oma töös reaalselt rakendada.

Enamiku peatükkide lõpus on harjutused. Need on mõeldud eelkõige teadmiste kinnistamiseks – igas uues organisatsioonis, meeskonnas või projektis ei pea neid uuesti tegema. Samas aitavad need kokku panna oma meeskonna jaoks sobiva dokumenteerimise juhendi.