Artiklis keskendutakse teemale, mis on seotud ettevõtte IT spetsialistiga, st tehakse selgeks võimalus luua omale lisakindlustus tulevikus nii teenuspartnerite kui ka IT spetsialistide valutuks vahetamiseks või kaasamiseks suuremate probleemide korral. Ehk siis seekord räägime lähemalt IT poole dokumenteerimisest.

Miks on IT dokumentatsioon siis tegelikult ka oluline

Mitmed ettevõtted, eriti väiksema suurusega, võivad tunda ära stsenaariumi, kus üks süsteemiadministraator on olnud vastutav kõigi arvutite ja võrgu konfigureerimiste ning installeerimiste eest. Ühel päeval juhtub aga ootamatult selle IT spetsiga õnnetus või ta lihtsalt lahkub ootamatult töölt (IT sektoris on näiteks töötajate üleostmine ju väga tavaline). Mis saab edasi?

Uue inimese leidmine on pikk protsess (ehk on siin abiks meie nõuanded) ja paratamatult hakkavad peatselt kerkima selles ettevõttes (mis kaotas just IT spetsialisti) üles probleemid võrgu või serveritega. Töötajad ei saa veateadetest ja hoiatustest aru ning ignoreerivad neid. Seejärel lähevad osad arvutid rivist välja ja isegi restart ei aita. Tuhnitakse läbi administraatori dokumendid ja peagi selgub, et tal olid sügavad teadmised IT keskkonnast, aga puudus praktiliselt igasugune dokumentatsioon süsteemist. Isegi paroole pole kuhugi salvestatud.

IT dokumentatsioon kui ettevaatusabinõu

Mida teeb eelpool mainitud ettevõte sel juhul edasi? Arvatavasti võetakse kiirelt ühendust mõne IT tuge pakkuva ettevõttega (nt Iteraction). Siiski, tulenevalt kadunud paroolidest ning dokumentatsioonist ei pruugita suuta olemasolevat süsteemi tööle saada. Palgatud  ettevõtte IT spetsialistid kulutavad tunde, et leida, kuhu serveritesse on rakendused installitud ja kus paikneb kogu oluline info. Seejärel peab see IT ettevõtte konsulteerima veel teiste spetsialistidega, kuna ettevõte kasutas tõenäoliselt lisaks standardtarkvarale ka oma valdkonna spetsiifilisi rakendusi, millest uus IT teenuspakkuja võibolla kuulnudki ei ole. 

Võib kuluda päevi või isegi nädalaid enne, kui kõik töötab jälle sama sujuvalt kui ennem. Vahepeal aga ei saa ettevõte tegeleda suuremate tellimustega piisavalt kiirelt, kuna info ja rakendused pole saadaval. Lõpuks kulusid kokku lüües läheb kõik ettevõttele küllalt palju maksma. Hullematel juhtudel võib seada isegi ohtu ettevõtte edasise tegutsemise. Et eelnevalt kirjeldatut vältida, peaks jälgima mõnda peamist IT dokumenteerimise reeglit.

• Tuleb luua detailne dokumentatsioon süsteemi seadetest ja parameetritest ning teha see kättesaadavaks.
• Hoida paroole kindlas kohas.
• Teha valmis ärijätkamise või kriisiolukorra plaan koos juhenditega, mida täpselt teha suuremate kahjustuste või probleemide korral.
• Seada paika süsteemihaldaja asendamise reeglid.
• IT dokumentatsioon peab olema piisavalt detailne, et suvaline IT teadlik isik saaks selle põhjal probleemi lahendada.
• Dokumentatsioon peab põhinema süsteemi kohta ajakohastel andmetel.

Tegelikult on juba IT dokumentatsiooni tegemine kasulik ettevõtmine, kuna sageli leiab selle käigus mitmeid olulisi süsteemi puudusi. Näiteks võid avastada, et olulistel andmetel puudub üldse backup, reaalselt süsteemi taastamine ei toimi nii nagu loodetud jne.

IT dokumentatsiooni parimad praktikad

Esmalt tuleks IT dokumentatsiooni puhul arvesse võtta mõningaid põhiküsimusi, nt milleks neid dokumente üldse vajatakse, kellele on nad mõeldud, miks on neid üleüldse vaja luua. Need üldised küsimused on olulised, kuna IT dokumentatsioon võib täita mitmeid erinevaid eesmärke: 

• defineerida projekti jaoks vajalikud komponendid (nõuete kataloog),
• kaardistada IT võrgu struktuuri, et vigasid oleks võimalik kiiremini parandada (juhend hädaolukordadeks),
• selgitada IT võrgu töötamist (opereerimise juhend).

Kui IT dokumentatsiooni eesmärk on selge, siis tuleb määrata sihtrühm, kelleks võivad olla:

• kasutajad (näiteks tegelikud IT võrgu kasutajad),
• tehniline meeskond (nagu tarkvara arendajad jne),
• administreeriv meeskond (näiteks projektijuhid, personalihaldurid jne.).

IT dokumentatsioonil puudub sageli selge struktuur, mistõttu võib olla keeruline ja aeganõudev lugeda mitmesaja lehelist dokumenti. Seetõttu tasuks jaotada IT dokumentatsioon loogilistesse alamkategooriatesse. Sõltuvalt nõuetest võivad need küll erineda, kuid järgnevalt loetletud osi peetakse standardseteks:

• tiitelleht (logo, pealkiri, autor, versioon, kuupäev),
• sisukord,
• sissejuhatus (mis võtab kokku sisu),
• sisu (sõltub dokumendi nõuetest),
• lisad.

Dokumentatsiooni juurde peaks kuuluma ka juhend, mis seab standardid üldistele IT dokumentidele ettevõttes ja sisaldab näiteks:

• reegleid dokumentide sisule, struktuurile ja paigutusele (versiooniindeksid, nimetused jne);
• reegleid individuaalsete dokumentide formaalsele disainile;
• reegleid dokumentatsiooni protsessidele, sealhulgas kohustused (määramise protsessid, läbivaatamise protseduurid, kinnitamise protsessid jne);
• järjepidevat terminoloogiat, mis on IT dokumentide puhul küllatki oluline.

Paljud ettevõtted loovad oma standardid või mallid sellest, mida IT dokumentide sisus täpsemalt kajastatakse. Kui see pole nii, siis leiab Google otsingust mitmeid kasulikke näiteid. Igal juhul tasub illustreerida oma võrgu informatsiooni ka piltide ja graafikutega. Visuaalne pool teeb lihtsamaks võrgu seostest arusaamise. Siiski kõik pildid ja graafikud peavad vastama sisule ja olema detailselt lahti kirjeldatud. On olemas ka teatud programme, mis võimaldavad mingil määral IT dokumenteerimist, aga Iteraction soovitaks pöörduda spetsialistide poole, kellel on sellealaseid kogemusi ja kes suudavad luua ettevõtte IT toest kasulikud dokumendid.

Kokkuvõtteks

On suureks abiks, kui on olemas kõikehõlmav, detailne ja ajakohane dokumentatsioon kogu ettevõtte võrgust koos kõigi oma riist- ja tarkvara komponentidega. Näiteks, kui mingil põhjusel läheb vaja välist teenuspartnerit, siis leiavad nad lihtsalt vajaliku tee probleemi lahendamiseks, kui neil on olemas tõhus IT dokumentatsioon. See võib säästa ühel halval päeval palju aega ja raha. 

Samas on üldine Eesti praktika selline, et IT dokumentatsioon on ettevõttel pigem moepärast ja see on tehtud pigem linnukese kirja saamise eesmärgil. Üldiselt pole keegi IT poolelt dokumenteerimise tööst vabatahtlikult huvitatud, mistõttu peaks ettevõte seda oma IT spetsialistidelt ka ise nõudma.