IT dokumentatsioon on tihtipeale aegunud, killustatud ja kasutu, kuid hästi tehtud dokumentatsioon IT projektides lihtsustab tööd ja hoiab kokku aega. Seda on võimalik teha! Selleks tuleb üle vaadata, kuidas dokumenteerimine käib – ja tulemuseks on optimaalne IT dokumentatsioon.
Sellelt lehelt leiad
Mis on IT dokumentatsioon ja miks see on oluline?
IT dokumentatsioon hõlmab kõiki projektiga seotud materjale, mis kirjeldavad ühiselt äriloogikat, protsesse, nõudeid ja süsteemi arhitektuuri.
Hästi läbimõeldud ajakohane ja mugavalt kirjeldatud dokumentatsioon aitab:
- Kiirendada tarkvaraarendust, vähendades möödarääkimisi ja segadust;
- Tagada teadmiste kättesaadavuse, isegi kui meeskonnaliikmed vahetuvad;
- Parandada otsuste tegemist, pakkudes selgust süsteemi arhitektuuris ja nõuetes;
Kahjuks liiga tihti dokumenteerimine ja eriti dokumentatsiooni uuendamine ei ole IT projektides järjepidev ja tulemuseks on juhuslik ja aegunud dokumentatsioon. Levinud on müüdid, mis väidavad, et dokumentatsioonist ei ole IT projektides nagunii kasu, see on nagunii aegunud ja üldsegi, see ei ole vajalik. Mina olen need müüdid ümber lükanud. Ma usun ja olen paljudes organisatsioonides näidanud, et alati ajakohane dokumentatsioon on võimalik ja väga kasulik.
Mõttetut tööd ei ole vaja teha ja ei ole ühte kindlat reeglit, mis peab IT projektide dokumentatsioonis olemas olema. Optimaalne IT dokumentatsioon tähendab piisava info kirjapanemist õigel ajal ja sobival viisil, ning selle ajakohasena hoidmist.
Hea dokumentatsioon on:
- kasulik – see aitab nii arendajaid kui ka äripoole inimesi igas arenduse etapis;
- optimaalne – kirja pannakse piisav info sellisel moel, et see on kergestimõistetav;
- ajakohane – vastab alati reaalsele olukorrale;
- mugav – kergesti leitav, loetav, hallatav ja arhiveeritav.
Minu kogemuses on ülal toodud parameetritele vastava optimaalse IT dokumentatsiooni loomine ja haldamine võimalik ja sugugi mitte liiga keeruline. Olen sellele detailsemalt otsa vaadanud ja sellel teemal isegi raamatu kirjutanud.