4.7. Dokumentatsioon

Infosüsteemi dokumentatsioon peab väljendama asutatava andmekogu põhiomadusi, eesmärki ning õiguslikku alust ehk karakteristikuid, mida sisuliselt hakkavad hilisema kooskõlastusprotsessi käigus hindama riigi infosüsteemi haldamise eest vastutavad asutused. Tehnilise dokumentatsiooni koostamise kvaliteedist sõltuvad hilisema asutamise piirid, kuivõrd omadusi, mida pole tehnilises dokumentatsioonis välja toodud, andmekogul olla ei või.

Dokumentatsiooni plokki pannakse kirja 

  • infosüsteemi tehniline kirjeldus, 
  • arhitektuuridokument,
  • kasutatavad klassifikaatorid, viidetena vanas RIHA-s kirjeldatud klassifikaatoritele (täpsem juhis vt käesoleva alapunkti lõpuosas; näiteks Kasutatav klassifikaator: EHAK 2018v2) ning 
  • muud teistele jagamiseks mõeldud dokumendid (liidestamise juhend, teenuste kirjeldus, kasutusjuhendid jms). 

Dokumentatsiooni plokki saab andmeid laadida üles failidena või lisada viiteid veebiressurssidele.

Dokumentatsioon

Nii veebilinkide kui ka failide puhul saab lisamisel või ka hiljem muutmisel märkida ka dokumendi liigi: arhitektuuridokument, andmekaitsealane mõjuhinnang, viide avaandmetele, kasutatav klassifikaator jne. Nii saab dokumentatsiooniga tutvuja või hindaja kiire esmase ülevaate lisatud dokumentatsiooni olemusest. Peatudes hiirega dokumendi või veebiviite uuendamise kuupäeval, kuvatakse ka vastava objekti lisamise kuupäev (kui see erineb muutmise kuupäevast).

Dokumendi liik

Kasutatava klassifikaatori lisamiseks tuleks toimida järgnevalt:

  1. Leia vanast RIHA-st (https://vana.riha.ee) klassifikaatorite moodul (peamenüüst Riigi infosüsteem > Klassifikaatorid).
  2. Kasutades otsingu vormi leia vajalik klassifikaator.
  3. Ava klassifikaatori kirje ning kopeeri RIHA sisene URL (vt allolev joonis).
  4. Mine uues RIHA-s oma infosüsteemi Dokumentatsiooni plokki ning lisa uus veebiviide.
  5. Kleebi URL-i lahtrisse vanast RIHA-st võetud veebiaadress, lisa viitele pealkiri, vali viite liigiks „Kasutatav klassifikaator“ ning salvesta.

Klassifikaatori lisamine

Veebilinkide puhul saab vajadusel muuta lingi aadressi ning viidatud veebiressursi pealkirja, failide puhul saab lisada juurdepääsupiirangu, märkides sel juhul ka juurdepääsupiirangu aluse ning piirangu kehtivuse ajavahemiku.

Juurdepääsupiirang

Juurdepääsupiiranguga failide pealkirju näevad kõik RIHA kasutajad, kuid neid avada saavad ainult infosüsteemi omanik ning RIHA hindajad.


Infosüsteemi dokumentatsiooni koostamisel on mõistlik jälgida kooskõlastavate asutuste menetluskorda, mis on saadaval RIA veebilehel https://www.ria.ee/et/riigi-infosusteem/riha/kooskolastamine.html. Viidatud dokumentides on üksikasjalikult toodud välja ka õiguslikud alused, millele hindamise käigus tuginetakse ning asjaolud, mida hindamisel kontrollitakse.


Last modified: Thursday, 28 March 2019, 5:05 PM