IT dokumentatsioon on üks olulisemaid ettevõtte digivaldkonna jätkusuutlikkuse tagajaid. Mida suuremaks ja keerulisemaks kasvab infosüsteem, seda rohkem sõltub ettevõtte igapäevategevus tehnoloogilistest lahendustest ning seda haldavate ja arendavate inimeste teadlikust tegutsemisest.

Mõistliku ulatusega ja ajakohane IT dokumentatsioon aitab ennetada probleeme, viia ellu ärihuvidest lähtuvat arengut ja edukalt reageerida eriolukordadele.

Dokumentatsiooniga ei tohi üle pingutada

Üldine reegel on, et dokumenteerida tuleb nii vähe kui võimalik ja nii palju kui vajalik. Tasakaalu otsimisel võib lähtuda kriteeriumist:

Teadmus peab olema dokumenteeritud nii, et töö/projekt/teema on päevapealt üle võetav asendaja poolt.

IT halduse ja arenduse dokumentatsiooni ajakohasena hoidmiseks on kriitiline leida selline tehnoloogiline lahendus ja tööviis, mis võimaldab töötajal uued teadmised ja näpunäited  kiiresti õigesse kohta tallele panna. Dokumenteerimine peab olema igapäevatöö loomulik osa ja ei tohi võtta ebamõistlikult palju pingutust.

Väga hea jätkusuutlik ja kasutajasõbralik viis teadmiste haldamiseks on vikid. Vikiliku teadmushalduse lipulaev on Atlassian Confluence. Hea näide vikipõhisest teadmushaldusest on Tartu Ülikooli arvutiabi avalik ala. Atlassian Confluence on väikeste meeskondade (10 inimest) jaoks tasuta.

Asendaja juhis

Ma ei tea, mida ma ei tea!

Üks praktiline lähenemine teadmiste haldamisele on asendaja juhiste ja tegevusjuhiste süsteem.

Asendaja juhis on koond parimast teadmusest konkreetse inimese tegemistest, arvestusega, et vajadus asendamiseks võib tulla päevapealt. Selles dokumendis on mõistlik kirjeldada regulaarsed igapäevarutiinid, olulised käsilolevad teemad/projektid, olulised kontaktisikud, ootel olevad teemad ja vajalikud juurdepääsud rakendustele/teenustele/ruumidele.

Tegemist on sisukorra-laadse dokumendiga, kus on koondatud ülevaade vajalikest tegevustest. Täpsemad tegevusjuhised on mõistik kirjeldada meeskonna ühisalas ja asendaja juhisest konkreetsele artiklile viidata.

Tegevusjuhised

Ma ei mäleta, mida ma ei mäleta!

Tegevusjuhiste koostamise eesmärk on tagada vastava tegevuse ühtlane kvaliteet ja teadmuse jätkusuutlikkus. Tegevusjuhisesse tuleb koondada parim teadmus tegevuse teostamiseks, arvestusega, et selle abil on võimalik toimetada tavapärasele teostajale lisaks ka ajutisel asendajal.

Juhis tuleb hoida ajakohasena – muutused või uued näpunäited tuleb tegevusjuhisesse lisada esimesel võimalusel.

Tegevusjuhise põhiandmed: tegevuse lühikirjeldus, tegevuse põhjus (miks?), teostaja(d), vastutaja. Tegevusjuhis peab olema paindlik – piisab lihtsast tabelist kahe veeruga “Samm või teema” ja “Olulised asjaolud (Mida? Kes? Kuidas?).

IT põhidokumentatsiooni ülevaade

Juhtimine

Dokument/teema Kirjeldus
Strateegia ja teekaart Digiarengu strateegilised põhimõtted ja suunad. 3-5 aasta projektide ja teemade edendamise teekaart.
Tegevuskava (aasta) IT valdkonna operatiivne tegevuskava. Esimene versioon eelarve koostamisel ja täpsustatud kord kvartalis.
Eelarve ja hankekava Eelarves on mõistlik välja tuua eraldi arengu ja korrashoiu kulud. Hankekava aitab planeerida õigeaegset tegutsemist ja kassavoogu.
Arendusportfell Ülevaade digiarengu projektidest ja staatustest. Arendusnõukogu prioriseerib projekte ja teostab edenemise järelevalvet.
Meeskonna ülevaade Ülevaade tööülesannete ja vastutuse jaotusest digimeeskonnas (nii palgalised töötajad kui teenuseosutajad).
Infosüsteemi ülevaade Kompaktne skemaatiline ülevaade ettevõtte infosüsteemi keerukusest – rakendused, teenused, taristu jmt.

Juhendamine

Dokument/teema Kirjeldus
Rakenduste ja teenuste kasutamise juhised Juhised rakenduse või teenuse tõhusa ja nutika kasutamise kohta.
Nutika töö juhised Näpunäited digikeskkonnas ja digivahendite abil oma töö korraldamiseks.
Korduma kippuvad küsimused Vastused sagedamini esinevatele probleemidele ja küsimustele. KKK lähenemine võimaldab prioriseeritud esile tuua kõige olulisemad näpunäited ja juhised.
Koolitusmaterjalid Süsteemne info rakenduste või valdkondlike teadmiste omandamiseks iseõppimise teel. Soovitav on kombineerida vikiliku lähenemisega ja kasutada lühikesi videosalvestusi.

Reeglid

Dokument/teema Kirjeldus
Infosüsteemi kasutamine Määratleb kasutajate õigused ja kohustused.
Infosüsteemi haldamine Määratleb infosüsteemi haldajate ja arendajate õigused ja kohustused.
Küberturbe nõuded Kirjeldab ettevõtte küberturbe põhimõtted, nõuded ja vastutajad.
Juurdepääsude haldamine Määratleb turvameetmed, millega tagatakse, et ainult volitatud isikutel on juurdepääs rakendustele, teenustele ja andmetele. Eraldi tuleb käsitleda priviligeeritud juurdepääsude (süsteemiülemad) haldus.
Arenduste läbiviimine Tagab korrektse protsessi infosüsteemi muudatuse plaanipärasel läbiviimisel.
Intsidentide haldamine Määratleb töökorra planeeritud ja planeerimata katkestuste ning kriiside haldamisel.
Riist- ja tarkvarastandard Riistvarastandard kirjeldab miinimumnõuded ja optimaalsed nõuded riistvarale. Tarkvara standardis on kirjeldatud töörollide kaupa kohustuslik tarkvara ja lubatud tarkvara.

Haldus ja arendus

Dokument/teema Kirjeldus
Rakenduste ja liideste ülevaade Kompaktne ülevaade ettevõtte infosüsteemi rakendustest ja nende liidestest. Soovitatav on skeemile lisada tabel olulisematest asjaoludest ja viidetest teadmusaladele ning tegevusjuhistele.
Andmete ülevaade Ülevaade ettevõtte infosüsteemis kasutatavatest andmetest ja nende juurdepääsutasemetest.
Rakenduste, teenuste ja tehnoloogia teadmus Süsteemne ja jätkusuutlik teadmushaldus rakenduste, teenuste ja tehnoloogiate haldamisest ja arendamisest. Soovitav on kasutada vikilikku lähenemist. Oluline on igale artiklile/dokumendile määrata selle ajakohasuse eest vastutaja.
Halduse tegevusjuhised Rakenduste, teenuste ja tehnoloogia haldamise detailsed tegevusjuhised. Peavad olema jooksvalt ajakohased ja lihvitud asendajate jaoks.
Tööde register Kasutajate soovide ja probleemide haldus ja teadmusbaas.
Küberturbe meetmete ülevaade Küberturbe meetmete ülevaade, riskipõhine arendus ja rakendamise haldus.
IT projektide teadmus Digiarengu projektide teadmus – tegevuskava, lähteülesanne, skoop, osalised jmt.
Teenuseosutajate ja -kokkulepete teadmus Ajakohane ülevaade teenuseosutajatest, nende kontaktandmest ja (lepingulistest) kokkulepetest.
Risikanalüüs, toimepidevusplaan ja taastusplaanid Küberturbe riskianalüüs, äritegevuse toimepidevusplaan ning sellega seotud teenuste ja rakenduste toimimise taastamise plaanid.
Küberturbe intsidentide register ja analüüs Ülevaade küberturbe intsidentidest, analüüs nende põhjustest ja vajalikest tegevustest küberturbe paremaks haldamiseks.
Seire logid Rakenduste ja teenuste toimimise ja kasutamise logid. Vajalikud probleemide avastamiseks, analüüsiks ja tõenditeks juurdlustes.
Operatiivinfo teavitus Lahendus töötajate ja avalikkuse teavitamiseks planeeritud ja planeerimata katkestustest, nende lahendamise protsessist ja juhistest kasutajatele.
Asendajate juhised Asendaja juhis on koond parimast teadmusest konkreetse ametikoha tegemistest, arvestusega, et vajadus asendamiseks võib tulla päevapealt. 


Jaga oma kogemust mõistliku IT dokumentatsiooni loomisel! Paremad palad lisame artiklisse.


Autor: Erkki Leego, digiarengu juht


Vt lisaks: