{"id":680,"date":"2023-10-30T09:17:07","date_gmt":"2023-10-30T09:17:07","guid":{"rendered":"https:\/\/itbac.eu\/?p=324"},"modified":"2024-03-03T16:04:06","modified_gmt":"2024-03-03T16:04:06","slug":"lukkame-umber-6-muuti-dokumenteerimise-kohta-it-projektides","status":"publish","type":"post","link":"https:\/\/dev.codenot.studio\/itbac\/lukkame-umber-6-muuti-dokumenteerimise-kohta-it-projektides\/","title":{"rendered":"L\u00fckkame \u00fcmber 6 m\u00fc\u00fcti dokumenteerimisest"},"content":{"rendered":"
\"Dokumentatsioon
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<\/small><\/strong><\/figcaption><\/figure>

Olge valmis, sest kohe l\u00f5hume dokumenteerimise m\u00fc\u00fcdid IT-projektides! Maja ehitamisel on dokumentatsioon A ja O, kuid tehnoloogiamaailmas on see tihti j\u00e4\u00e4nud unarusse.<\/p>

M\u00fc\u00fcdid kummutab j\u00e4rgnevas artiklis Kaja Trees, kes on kogenud \u00e4ri- ja s\u00fcsteemianal\u00fc\u00fctik ning teeb koolitusi muuhulgas ka teemal \u201cOptimaalne dokumentatsioon: piisav, seotud ja ajakohane\u201d (loe koolituse kohta l\u00e4hemalt SIIT<\/a>). Kaja selgitab, miks dokumentatsioon ei ole koorem, vaid v\u00e4\u00e4rtuslik abimees meie teekonnal IT-maailmas.<\/p>

1. Keegi nagunii dokumentatsiooni ei loe<\/h2>

Kaja soovitab unustada detailse dokumentatsiooni, kus iga n\u00fcanss on t\u00e4pselt kirjas ja m\u00f5elda selle asemel, kellele see info tegelikult oluline on ja lisa ainult vajalik.<\/p>

Kliendikokkulepped, t\u00f6\u00f6\u00fclesanded ja vastutajad \u2013 need on p\u00f5hit\u00f5ed, mis peaksid kindlasti dokumentatsioonis kajastuma. Need aitavad projektijuhil hoida projekti liikumas ja arendajal teada, mis on tema vastutusala.<\/p>

Kui uus meeskonnaliige \u00fchineb, on j\u00e4llegi hea, kui ta saab vajaliku info dokumentatsioonist, mitte suulise p\u00e4rimuse kaudu. Kui liitub n\u00e4iteks tehniline meeskonnaliige, siis tema jaoks on raamistike, t\u00f6\u00f6riistade ja projekti t\u00f6\u00f6korralduse m\u00f5istmine kriitilise t\u00e4htsusega.<\/p>

2. Kood on dokumentatsioon<\/h2>

Kaja \u00fctleb, et kood on dokumentatsioon samav\u00f5rd kui maailm on maakaart!<\/p>

Jah, koodis on palju infot, kuid suurte s\u00fcsteemide puhul v\u00f5ib sellest \u00fclevaate saamine olla nagu Tallinna kesklinnas seistes tee leidmine Rooma. Kood on v\u00e4ga detailne ja sellest \u00fclevaadet saada on keeruline.<\/p>

Lisaks, kood ei ole kliendile arusaadav ja ei kirjelda kokkuleppeid \u2013 kui kood on dokumentatsioon, siis ei saa olla \u00fchtegi \u201cbugi\u201d! Absoluutselt k\u00f5ik muudatused tuleb kliendil kinni maksta, sest selle loogika j\u00e4rgi oleks nagu koodis alati k\u00f5ik \u00f5ige, isegi kui arendaja on millestki valesti aru saanud.<\/p>

Hea dokumentatsioon aitab k\u00f5igil aru saada, mida tarkvara teeb, ja koodis orienteeruda.<\/p>

3. Dokumenteerimine v\u00f5tab liiga palju aega<\/h2>

Kaja annab n\u00f5u, et \u00fcksikasjaliku dokumenteerimise peale ei maksa liigselt aega kulutada. M\u00f5tle, millist infot tegelikult vaja on, ja dokumenteeri ainult seda. Sellise dokumentatsiooni loomise ajakulu on nagu investeering, mis hiljem end koos intressidega \u00e4ra tasub, kui seda saab kasutada uuenduste ja muudatuste planeerimiseks.<\/p>

4. Dokumentatsioon on alati aegunud<\/h2>

Kaja selgitab, et dokumentatsioon ei pea aeguma! Oma projektides on ta seda \u00f5ppinud ajakohasena hoidma.<\/p>

P\u00f5hiline nipp selle juures on lisada dokumentatsiooni uuendamine loomulikku protsessi sobivasse kohta \u00fche tegevusena \u2013 nii et tarkvara ei uuendata ilma dokumentatsiooni uuendamata.<\/p>

5. Kellelegi ei meeldi dokumentatsiooni kirjutada<\/h2>

Kaja toob v\u00e4lja, et temale meeldib t\u00f5es\u00f5na dokumenteerida ja tegelikult on palju inimesi, kes naudivad dokumentatsiooni kirjutamist.<\/p>

Vali oma meeskonda mitmekesiseid inimesi ja lase iga\u00fchel tegeleda sellega, mis talle meeldib. See on ka \u00fcks p\u00f5hjuseid, miks on v\u00e4hegi suurema projekti puhul hea lisada projektimeeskonna hulka ka anal\u00fc\u00fctik v\u00f5i isegi mitu. Iga\u00fcks saab tegeleda selle osaga t\u00f6\u00f6st, mis talle meeldib.<\/p>

6. Agiilses l\u00e4henemises ei ole dokumentatsiooni<\/h2>

Kaja paneb paika, et 2001. aastal loodud Agiilse tarkvaraarenduse manifest<\/a> kirjutas \u201cHindame \u2026 t\u00f6\u00f6tavat tarkvara rohkem, kui k\u00f5ikeh\u00f5lmavat dokumentatsiooni!\u201d ja sellele j\u00e4rgnenud rohkem kui 20 aasta jooksul on seda liigagi tihti t\u00f5lgendatud kui \u201cme ei hinda dokumentatsiooni\u201d.<\/p>

Unustatakse \u00e4ra, et juba sellessamas manifestis on kirjas: \u201cKa parempoolsetel teguritel on v\u00e4\u00e4rtus, kuid me hindame vasakpoolseid tegureid k\u00f5rgemalt.\u201d Muidugi on olulisim, et tarkvara t\u00f6\u00f6taks, aga selle saavutamisel on hea dokumentatsioon v\u00e4\u00e4rtuslikuks abivahendiks.<\/p>

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

Kaja Treesi koolitusel \u201cOptimaalne dokumentatsioon: piisav, seostatud ja ajakohane\u201d saad \u00f5ppida, kuidas loomulikul moel kirjutada ja uuendada dokumentatsiooni nii, et see annab maksimaalselt kasu minimaalse pingutuse juures.<\/p>