Lükkame ümber 6 müüti dokumenteerimise kohta IT-projektides

Dokumentatsioon ei ole vaenlane, vaid kaaslane, kes aitab meeskonnal paremini navigeerida IT-maailma keerukustes. Oluline on leida tasakaal, mis sobib sinu projekti ja meeskonnaga.Foto: Shutterstock

Olge valmis, sest kohe lõhume dokumenteerimise müüdid IT-projektides! Maja ehitamisel on dokumentatsioon A ja O, kuid tehnoloogiamaailmas on see tihti jäänud unarusse.

Müüdid kummutab järgnevas artiklis Kaja Trees, kes on kogenud äri- ja süsteemianalüütik ning teeb koolitusi muuhulgas ka teemal “Optimaalne dokumentatsioon: piisav, seotud ja ajakohane” (loe koolituse kohta lähemalt SIIT). Kaja selgitab, miks dokumentatsioon ei ole koorem, vaid väärtuslik abimees meie teekonnal IT-maailmas.

1. Keegi nagunii dokumentatsiooni ei loe

Kaja soovitab unustada detailse dokumentatsiooni, kus iga nüanss on täpselt kirjas ja mõelda selle asemel, kellele see info tegelikult oluline on ja lisa ainult vajalik.

Kliendikokkulepped, tööülesanded ja vastutajad – need on põhitõed, mis peaksid kindlasti dokumentatsioonis kajastuma. Need aitavad projektijuhil hoida projekti liikumas ja arendajal teada, mis on tema vastutusala.

Kui uus meeskonnaliige ühineb, on jällegi hea, kui ta saab vajaliku info dokumentatsioonist, mitte suulise pärimuse kaudu. Kui liitub näiteks tehniline meeskonnaliige, siis tema jaoks on raamistike, tööriistade ja projekti töökorralduse mõistmine kriitilise tähtsusega.

2. Kood on dokumentatsioon

Kaja ütleb, et kood on dokumentatsioon samavõrd kui maailm on maakaart!

Jah, koodis on palju infot, kuid suurte süsteemide puhul võib sellest ülevaate saamine olla nagu Tallinna kesklinnas seistes tee leidmine Rooma. Kood on väga detailne ja sellest ülevaadet saada on keeruline.

Lisaks, kood ei ole kliendile arusaadav ja ei kirjelda kokkuleppeid – kui kood on dokumentatsioon, siis ei saa olla ühtegi “bugi”! Absoluutselt kõik muudatused tuleb kliendil kinni maksta, sest selle loogika järgi oleks nagu koodis alati kõik õige, isegi kui arendaja on millestki valesti aru saanud.

Hea dokumentatsioon aitab kõigil aru saada, mida tarkvara teeb, ja koodis orienteeruda.

3. Dokumenteerimine võtab liiga palju aega

Kaja annab nõu, et üksikasjaliku dokumenteerimise peale ei maksa liigselt aega kulutada. Mõtle, millist infot tegelikult vaja on, ja dokumenteeri ainult seda. Sellise dokumentatsiooni loomise ajakulu on nagu investeering, mis hiljem end koos intressidega ära tasub, kui seda saab kasutada uuenduste ja muudatuste planeerimiseks.

4. Dokumentatsioon on alati aegunud

Kaja selgitab, et dokumentatsioon ei pea aeguma! Oma projektides on ta seda õppinud ajakohasena hoidma.

Põhiline nipp selle juures on lisada dokumentatsiooni uuendamine loomulikku protsessi sobivasse kohta ühe tegevusena – nii et tarkvara ei uuendata ilma dokumentatsiooni uuendamata.

5. Kellelegi ei meeldi dokumentatsiooni kirjutada

Kaja toob välja, et temale meeldib tõesõna dokumenteerida ja tegelikult on palju inimesi, kes naudivad dokumentatsiooni kirjutamist.

Vali oma meeskonda mitmekesiseid inimesi ja lase igaühel tegeleda sellega, mis talle meeldib. See on ka üks põhjuseid, miks on vähegi suurema projekti puhul hea lisada projektimeeskonna hulka ka analüütik või isegi mitu. Igaüks saab tegeleda selle osaga tööst, mis talle meeldib.

6. Agiilses lähenemises ei ole dokumentatsiooni

Kaja paneb paika, et 2001. aastal loodud Agiilse tarkvaraarenduse manifest kirjutas “Hindame … töötavat tarkvara rohkem, kui kõikehõlmavat dokumentatsiooni!” ja sellele järgnenud rohkem kui 20 aasta jooksul on seda liigagi tihti tõlgendatud kui “me ei hinda dokumentatsiooni”.

Unustatakse ära, et juba sellessamas manifestis on kirjas: “Ka parempoolsetel teguritel on väärtus, kuid me hindame vasakpoolseid tegureid kõrgemalt.” Muidugi on olulisim, et tarkvara töötaks, aga selle saavutamisel on hea dokumentatsioon väärtuslikuks abivahendiks.

Dokumentatsioon ei ole vaenlane, vaid kaaslane, kes aitab meeskonnal paremini navigeerida IT-maailma keerukustes. Oluline on leida tasakaal, mis sobib sinu projekti ja meeskonnaga.

Kaja Treesi koolitusel “Optimaalne dokumentatsioon: piisav, seostatud ja ajakohane” saad õppida, kuidas loomulikul moel kirjutada ja uuendada dokumentatsiooni nii, et see annab maksimaalselt kasu minimaalse pingutuse juures.

See on võimalus, mida ei tohiks maha magada! Piletid 30. oktoobril 2023 toimuvale eestikeelsele koolitusele saad soetada SIIT ja 6. novembril ning 8. novembril 2023 toimuvale inglise keelsele koolitusele SIIT.

Mis on DigiPRO ja kes seda teevad? Loe siit

Populaarsed lood mujal Geeniuses

Kolm korda nädalas

Telli DigiPRO uudiskiri

Kolm korda nädalas (esmaspäeviti, kolmapäeviti ja reedeti) spetsiaalne DigiPRO liikmetele tehtud kommenteeritud uudiskiri, et sa midagi olulist maha ei magaks. Iga uudiskirja magnet on meie ajakirjanike kirjutatud pikem artikkel, mis meie arvates võiks selles valdkonnas töötavaid inimesi huvitada ja neile vajalik olla