Kuidas dokumenteerida IT projekte?
Raamat Optimaalne dokumentatsioon – kasulik, ajakohane ja mugav on praktiline käsiraamat IT projektide dokumentatsiooni haldamiseks.
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. Praktiline
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.
Harjutused
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.
Avaldamine
Olen valinud välja kirjastuse, kellega teha koostööd raamatu avaldamisel – Kuldne Lammas. Olen näinud nende abiga välja antud raamatuid ja ei näinud viga laita. Samuti on vähemalt pakkumise tegemise faasis olnud nendega väga sujuv ja kiire suhtlus.
Samuti olen otsustanud teha koostööd digiraamatu väljaandmisel EDRK-ga. Selle tulemusel peaks minu e-raamat jõudma kiiresti ka Apollo ja Rahva Raamatu e-poodidesse.
Praeguse hinnangu kohaselt võiks e-raamat ilmuda aprillis ja paber-raamat mais.
Eelmüük
Minu enesekindlus selles osas, et raamatu päriselt avaldan, on juba piisavalt suur, et avatud on raamatu eelmüük!
Raamatu staatus: tagasiside alusel kohandamine
1. mustand
2. mustand
e-raamat
trükk
tõlge
viimane muutmine 17.03.2025
tagasiside alusel täiendamine
17.03.2025 seis
Olen saanud enamuselt testlugejatelt tagasiside raamatule kätte. See on julgustav! Toon siin välja Kätlin Jürsi antud tagasiside alguse/üldise osa:
Hindan raamatu väga kasulikuks alustavatele analüütikutele või ettevõtetele, kellel veel analüütikud polegi ning kes kaaluvad selle rolli loomist. Annab väga head teadmised, kuidas analüütikud dokumentatsiooni loovad ja korras hoiavad. Samuti väga hea ülevaade erinevatest tehnoloogilistest võimalustest.
Kuigi ma ei oma selles vallas palju kogemust, sain siiski mitmes kohas kinnitust enda töömeetoditele. Samas sain ka mitmeid uusi mõtteid, kuidas enda tööprotsesse tulevikus paremini hallata. Näiteks see release järgne dokumentatsiooni uuendamine. Päris palju kohti joonisin alla (kirjutasin juurde “väga hea point!”) ja plaanin selle raamatu veelkord töö kõrvalt läbi töötada ja praktikaid rakendada. Kõike infot ei jõua niikuinii kohe läbi mõtestada.
Samuti rahustas see raamat mind ka selles osas, et see ongi ok, kui dokumentatsioon areneb (ei ole täiuslik!) ning analüütik saab vastavalt vajadusele otsustada, mismoodi asju kajastada.
Lisaks on muidugi palju tagasisidet selle kohta, kus midagi selgemini saaks väljendada, kus lisada näiteid või jooniseid. Jah, olen väga päri – ka raamat ise rõhutab, et need on olulised dokumentatsiooni juures! Just sellist tagasisidet ma testlugejatelt ootasingi ja selle abiga saab raamat palju parem!
Nüüd panengi fookuse raamatu sisu lihvimisele, näidete ja jooniste lisamisele. Loodan sellega valmis saada märtsikuu jooksul, et aprillis saaks e-raamat ilmuda ja mais juba paberil.
