Registrite ja Infosüsteemide Keskus · 20. mai 2022
Sisu (failidest)
Dokumentatsiooniplaan v2
versioon 2.0
Täitja poolt Tellijale üle antavad dokumendid
Arenduste kirjeldus
Arhitektuuri kirjeldus
Seadmete ja tarkvara kasutusjuhendid
Testplaan ja testimise tulemusena valminud dokumendid
Varundus/taasteplaan
Versiooni kirjeldus
Nõuded arendustele vastavustabel
Front-end nõuete vastavustabel
Andmekogude semantiline kirjeldus ja koosseis
Dokumendid peavad vastama vähemalt alljärgnevatele tingimustele
Tehnilise dokumentatsiooni võiks võimaluse korral hoida git’is koodi juures .md failides (näiteks dokumendid, mis on suunatud arendajale ja administraatorile)
Ärilised dokumendid peavad olema RIK Confluence keskkonnas
Dokumendi nimi hankelepingus Dokumendi sisu vastavalt arenduslepingule Sihtgrupp
1 Arenduste kirjeldus Dokumendi/dokumentide eesmärgiks on anda selge ja konkreetne ülevaade süsteemi sisust ja realiseeritud arendustest.
Tellija
Eraldiseisvaid dokumente üle ei anta vaid RIK Confluence keskkonda kirjutatakse analüüsi jooksvalt projekti käigus. äriprotsesse
valdavad
Kirjeldused peavad olema kinnitatud Tellija poolt enne arendustöö algust. kontaktisikud:
ärianalüü
Üle antavad dokumendid peavad sisaldama: tikud
süsteemi
Infosüsteemi terviku kirjeldus – olemasoleva süsteemi täiendamisel lisatud/muudetud osade kirjeldus. Tegemist on süsteemi ärisisul põhinevate analüütik
baaskomponentidega, millele toetuvad kasutaja tegevused, ekraanivormid, kasutuslood/protsessid, teenused, jms; ud
Vormide (ekraanivormide) kirjeldused; Täitjast
Kasutuslugude / vormide kasutamise protsesside / tegevuste kirjeldused; sõltumatud
Infosüsteemi teenuste kirjeldused. tarkvara
hooldajad
arendaja
d ja
edasiare
ndajad
testijad
arhitektid
projektiju
hid
2 Arhitektuuri kirjeldus Dokumendi eesmärgiks on kirjeldada loodava süsteemi tehnilist ülesehitust. Kirjeldatakse rakenduse loogilist struktuuri, näidates ära selle kihtideks jagunemise.
Kirjeldatakse ka füüsilist arhitektuuri, antakse ülevaade kasutatavatest tehnoloogiatest ning vahenditest. arhitekt
administraator
Dokument peab rahuldama vähemalt alljärgnevaid sisunõudeid: turvaspetsialist
topoloogia, süsteemi füüsiline arhitektuur (süsteemi komponendid andmebaasiserver, rakendusserver, meiliserver jms):
süsteemi soovituslikud näitajad komponentide kaupa, näiteks andmesidekiirused, andmemahud, protsessori kiirus, mälumaht, komponentide arv süsteemi
osade kaupa, kettasüsteemi jõudlus jms;
liidesed teiste süsteemidega (x-tee, meilisüsteemid) ja sõltuvused teistest süsteemidest;
süsteemi tehnilised (sh automaatsed) protsessid ehk töövoog – komponentide omavahelised suhtlusstsenaariumid ja koostoimimine (näiteks, mis komponent
ja millal pöördub RR teenuse poole);
kolmandate osapoolte poolt toodetud kasutatavad tarkvarad/riistvarad, mis on vajalikud süsteemi toimimiseks;
süsteemi krüpto-, allkirjastamise, digitemebeldamise lahendused ja algoritmid.
Esmane kirjeldus esitatakse enne arendustööde algust.
Täiendatud kirjeldus antakse üle koos vaheetapi üleandmise aktiga.
Lõplik (täielik) kirjeldus esitatakse lõppaktiga
3 Seadmete ja tarkvara Süsteem tuleb ehitada selliselt, et see ei vajaks täiendavaid selgitusi (oleks intuitiivne).
tarkvara
kasutusjuhendid Siiski võib teatud hetkedel kasutaja vajada täiendavat infot, mis aitaks kasutajatel mõista, kuidas oma ülesandeid täita, sellisel juhul peab info sisu olema hõlpsasti kasutajad
leitav ja keskenduma kasutaja ülesandele. Seega tuleks alati eelistada kasutajale kontekstipõhist abiinfo andmist, mis on realiseeritud UI vaates, milles kasutaja haldurid
parasjagu oma ülesandeid täidab.
Abiinfo peab olema lühike ja sisaldama konkreetsete sammude kirjeldusi, mis tuleb läbi viia.
Kasutusjuhendi materjali eraldiseisvalt üle ei anta, vaid need kuuluvad üle antava rakenduse juurde.
4 Administreerimisjuhend, paigal Juhend on aluseks süsteemi administreerimisele, paigaldamisele ja seadistamisele.
dusjuhend haldurid
Juhend peab rahuldama vähemalt alljärgnevaid sisunõudeid: projektijuht
adminitraator
süsteemi parameetrite (seadistuste) kirjeldus ning nende muutmiste mõjud ja protseduurid (näiteks .net rakenduste puhul konfiguratsiooniparameetrite arhitekt
kirjeldused/selgitused ja näidisväärtused);
logimise realisatsiooni kirjeldused (kuhu ja mida, kas kasutatakse roteerimist või katalogiseerimist jms);
rutiinsete hooldusprotseduuride kirjeldus;
paigalduspaketi koostamise protseduurid;
paigaldusprotseduurid;
süsteemi halvamist võimaldavad riskid ja nende esinemise võimalikkus.
Paigaldusjuhendis kirjeldatakse iga realiseeritud osa rakendamine (deployment) koos spetsiifiliste seadistustega. Paigaldusprotseduurid peavad olema kirjutatud
selliselt, et RIK-i administraator suudab rakenduse paigaldada ja seadistada ilma kõrvalise abita.
Etapi juhendid antakse üle koos vaheetapi üleandmise aktiga.
Lõplikud (täielikud) juhendid esitatakse lõppaktiga.
5 Testplaan ja testimise Annab detailse ülevaate teostatud arenduste testimisest ning testimise tulemustest.
projektijuht
tulemusena valminud Kesksel kohal on testplaan, mis kirjeldab testimise strateegia, skoobi, vahendid, tegevused, tulemid jne. Vastavalt kokkuleppele koostatakse testlood, mis vastuvõtu
dokumendid võivad olla laiendatud kasutuslood. testijad
Vastavalt kokkuleppele teostatud funktsionaalsuse-, jõudluse-, koormuse-, integratsiooni-, kasutatavuse-, turvalisuse- jm. testimise dokumendid (plaan, lood,
juhendid, puudused, puuduste kõrvaldamise info, tulemid).
Testimisel ilmnenud vead ning paranduste info (versiooniinfo, vajadusel sisu).
Testimise otstarbel loodud kood, skriptid, kasutusjuhendid.
Testimise dokumentatsioon ei pea olema üks dokument, dokumendid võib grupeerida loogilisteks osadeks:
Testplaan
Nõuetele vastavus
Testlood
Etapi juhendid antakse üle koos vaheetapi üleandmise aktiga.
Lõplikud (täielikud) juhendid esitatakse lõppaktiga.
6 Varundus/taasteplaan Tagada süsteemi hävingujärgne kiire ja tõrgeteta taastamine.
administraator
Taasteplaan on aluseks süsteemi taastamisele peale suuremat hävingut.
Taasteplaan peab rahuldama vähemalt alljärgnevaid sisulisi nõudeid:
1. Süsteemi backup’id, varundamisele kuuluvate komponentide ja asukohtade loetelu (nt rakenduse konfiguratsioonifailid, rakenduse failid failiserveril paiknevad
failid ja andmebaas jne), nende kirjeldused ja kasutuselevõtu protseduurid (Näiteks: tuua kataloogi (vajadusel faili) tasemel välja list failidest, mida peab
varundama; varunduse järjekord (kui see on oluline);
2. Taastamise sammud kasutades installatsiooni juhendit ja varundatud andmeid;
3. Süsteemi komponentide asendusvõimalused, nende alternatiivkomponentide spetsifikatsioonid. Miinimumis peab vastama küsimusele: milline riistvara/tarkvara
on sobiv arendaja arvates (tehtud nt jõudlustestid) seda süsteemi käitama.
Esmane dokument esitatakse enne arendustööde algust.
Täiendatud dokument antakse üle koos vaheetapi üleandmise aktiga.
Lõplik (täielik) dokument esitatakse lõppaktiga.
7 Versiooni kirjeldus Vajalik ülevaate saamiseks infosüsteemi versioonide sisust.
projektijuht
Detailne info iga versiooniuuenduse kohta:
avaldamise kuupäev
versiooni number
versiooni tüüp (peamine, vaheversioon, parandus, erakorraline)
versiooni sisu - milliseid teostatud arendusi sisaldab (töökasu numbrid, näiteks Jira taskide numbrid ja/või lingid taskile)
leitud, kuid parandamata vead
Versioni kirjeldus võib põhineda tarnitud Jira piletitel.
Esitatakse koos iga üleantava versiooniga ja iga versiooni kohta.
8 Nõuded arendustele Kontrolltabel nii Täitjale kui ka Tellijale veendumaks, et arvestatud on hankes nõutud arenduse nõuetega.
arhitekt
vastavustabel Kõik raamlepingus, lähteülesandes või tehnilises kirjelduses kirjeldatud mittefunktsionaalsed nõuded ning täitmismärge. administraator
turvajuht
Täitmismärke tegemise aluseks peab olema testimine. Vajadusel lisatakse selgitused.
Esmane dokument esitatakse enne arendustööde algust.
Täiendatud dokument antakse üle koos vaheetapi üleandmise aktiga.
Lõplik (täielik) dokument esitatakse lõppaktiga.
9 Front-end nõuete Kontrolltabel nii Täitjale kui ka Tellijale veendumaks, et arvestatud on hankes nõutud front-end nõuetega.
arhitekt
vastavustabel Kõik raamlepingus, lähteülesandes või tehnilises kirjelduses kirjeldatud front-end nõuded ning täitmismärge.
Täitmismärke tegemise aluseks peab olema testimine. Vajadusel lisatakse selgitused.
Esmane dokument esitatakse enne arendustööde algust.
Täiendatud dokument antakse üle koos vaheetapi üleandmise aktiga.
Lõplik (täielik) dokument esitatakse lõppaktiga.
10 Andmekogude Vajalik ülevaate saamiseks, mis andmed andmekogus on ja mida need tähendavad.
tellija
semantiline kirjeldus ja Andmekogus töödeldavate andmete koosseisu kirjeldus sisaldab: tellija poolne
koosseis projektijuht
vanemandmeobjekti nimetus (tabeli nimetus);
andmeobjekti nimetus (veeru nimetus);
märge, kas tegemist on isikuandmetega;
märge, kas tegemist on eriliigiliste isikuandmetega;
märge, kas tegemist on andmekogu põhiandmetega;
märge, kas tegemist on arhiiviväärtuslike andmetega;
viide andmekogule, kust mittepõhiandmed pärinevad;
andmeobjekti semantiline kirjeldus (selgitus, mis andmeobjektiga on tegemist).
(Kõik märked formaadis jah/ei.)
Dokument (fail) esitatakse lõppaktiga.
Nõuded testimisele v1.2
versioon 1.2
Sisukord
Sissejuhatus
1. Üldine AO-N-TE-Y
2. Dokumentatsioon AO-N-TE-D
3. Testplaan ja -lood AO-N-TE-T
4. Logimine, raporteerimine AO-N-TE-R
5. Nõuded testidele AO-N-TE-N
6. Lähtekood ja spetsiaalsed tööriistad AO-N-TE-I
7. Alusandmed AO-N-TE-A
8. Koormus- ja stressitestid AO-N-TE-S
Sissejuhatus
Enne projekti tegelikku algust lepitakse kokku kõik erisused - millised punktid vastavas projektis ei rakendu (pole võimalik/vajalik) ja kas rakenduvad mingid täiendavad punktid või all-loetletud punktidele
täpsustused.
1. Üldine AO-N-TE-Y
Nõue Sisu
AO-N- Kõikide üle antavate tarkvara versioonidega peavad kaasas olema vastavad testid, nendega seotud dokumentatsioon ning kirjelduse või raporti leitud ja parandatud vigadest.
TE-Y-1
AO-N- Tarkvara vastuvõtmiseks vajalikud hankevõitja poolsed testimised ja skoop (osa testplaanist) lepitakse kokku projekti alguses ning seda muudetakse poolte kokkuleppel.
TE-Y-2
AO-N- Vastavalt kokkuleppele tuleb koostada ning üle anda punktis AO-N-TE-Y-2 nimetatud testplaan ja testlood ning eraldi testprojekti ja -programmi puhul ka vajaminev dokumentatsioon ja
TE-Y-3 kirjeldus.
AO-N- Testitava tarkvara lõplik versioon peab läbima vastavad nõuded koormusele/jõudlusele (ISKE,SLA jm.). Selle tõestamiseks tuleb tarnida ka vastavad testid.
TE-Y-4
AO-N- Üle antud testides või vastuvõtutestimisel esinenud probleemid tuleb parandada sarnaselt põhiarendusega.
TE-Y-5
AO-N- Testid peavad olema loogiliselt grupeeritud ning numereeritud, nii et skriptide või tööriistade abil saab kindlat osa käivitada. Näiteks teenuse- või tüübi kaupa (süsteemitestid, koormustestid
TE-Y-6 vm.).
AO-N- Üle antud testide käivitamiseks ei pea RIK soetama lisatarkvara. Näiteks automaattestid, koormustestid jm. võiks olla kirjutatud C#+NUnit'is, Selenium'is, JMeter'is, Robot Framework'is või
TE-Y-7 Gattling'us. Kokkuleppel Java+JUnit, Cypress või muu.
2. Dokumentatsioon AO-N-TE-D
Nõue Sisu
AO-N-TE-D- Dokumentatsiooni eesmärgiks on edasi anda kogu vajalik informatsioon testide kohta (testplaanid, testlood, testide käivitamiseks, jooksutamiseks ja valideerimiseks vajalik informatsioon
1 jne).
AO-N-TE-D- Dokumentatsioon peab olema versioneeritud ning iga punkti (Näiteks Testlugu) juures peab olema tekkimise aeg, viimase muudatuse aeg, autor, muutja.
2
3. Testplaan ja -lood AO-N-TE-T
Nõue Sisu
AO-N- Testplaanile ja –lugudele rakendub peatükk AO-N-TE-D-2 .
TE-T-1
AO-N- Testplaan kirjeldab ning selgitab kogu tarkvaraga seotud testimist, kui ei ole kokku lepitud teisiti.
TE-T-2
AO-N- Testlood tulenevad kasutuslugudest ja/või süsteemianalüüsi nõuetest, nende kattumisel piisab testimise kirjeldusest, et vältida dokumentatsiooni dubleerimist.
TE-T-3
AO-N- Testloos peab minimaalselt olema: testi kirjeldus, viide nõudele või kasutusloole, etapid, oodatud tulemus, tegelik tulemus.
TE-T-4
AO-N- Testprojekti ja –programmi puhul võib kood koos kommentaaridega täita testloo rolli (Näiteks Testi nimetus viitab kindlale testloole või süsteeminõudele, C# kirjutatud süsteemitesti
TE-T-5 nimetamisloogika ja kommentaarid teevad kergelt selgeks tegevuste ahela).
4. Logimine, raporteerimine AO-N-TE-R
Nõue Sisu
AO-N- Raportitele rakendub peatükk AO-N-TE-D-2 . Eraldi raporteid pole tingimata vaja kui kasutatakse ühist JIRA + Confluence keskkonda.
TE-R-1
AO-N- Testraportis kajastatud vigade juures peab olema märgitud tarne versioon, milles viga leiti ning milles see on kõrvaldatud.
TE-R-2
AO-N- Automaatsete testide puhul peab automaatselt genereeruma testraport või statistika tegemiseks vajalik logi (Näiteks NUnit genereerib ise raporti, JMeteris Summary Report+ Aggregate Report
TE-R-3 või eraldi .csv fail jne.).
AO-N- Koormus- ja stressitestide puhul peab raport kajastama, millise koormuse juures hakkasid testid negatiivseid tulemusi saama ning millised vead esinesid.
TE-R-4
AO-N- Koormus- ja stressitestide juures on vaja minimaalselt välja tuua: saadetud päringute arv, min. päringu käitlemise aeg(ms), max. päringu käitlemise aeg(ms), päringute käitlemise standardhälve
TE-R-5 (ms), keskmine päringu käitlemise aeg(ms), vigade %, läbilaskevõime(tegevust/sek.), 90/95/99 protsentiilid.
5. Nõuded testidele AO-N-TE-N
Nõue Sisu
AO-N-TE- Testprojekti ja –programmi testide juures rakendub peatükk AO-N-TE-D-2 , lisaks peab testi juurde märkima testi tegija ning tarkvara versiooni, millele test koostati.
N-1
AO-N-TE- Süsteemitestidega peavad olema kaetud kõik süsteemi osad, kui ei ole kokku lepitud teisiti (Näiteks kõik arendatud teenused, kasutajaliidesega rakenduse testlood jne.).
N-2
AO-N-TE- Iga test peab olema süsteemi- või ärianalüütiliselt terviklik põhjendatav kooslus (Näiteks ühes testis ei testita kahte erinevat teenust või süsteemi viga).
N-3
AO-N-TE- Iga teenuse kohta peab olema Smoke test, mis kontrollib lihtsaima sisendiga teenuse töökorda.
N-4
AO-N-TE- Kuna RIKis arendatakse pideva integratsiooni mudelit järgides, siis peab olema võimalik teste valikuliselt grupeerida ning neid automaatselt käivitada (Näiteks Grupp „Nightly" öiste
N-5 integratsioonitestide jaoks).
AO-N-TE- Testsessioonid ning omavahel mitte seotud testid ei tohi üksteist mõjutada.
N-6
6. Lähtekood ja spetsiaalsed tööriistad AO-N-TE-I
Nõue Sisu
AO-N-TE-I- Spetsiaalselt arendatud testprojektile ja -programmile rakenduvad „Nõuded arendustele –Nõuded rakenduse koodile" .
1
AO-N-TE-I- Spetsiaalselt arendatud testprojektid peavad kasutama üldtuntud raamistikke Näiteks NUnit, JUnit.
2
AO-N-TE-I- Kui testprojekt kasutab Objektide kihte, omab teenuste kihti või koodi osa, mida saab WSDL, andmebaasi või muu pealt genereerida, siis selleks peab kasutama tööriistu (Näiteks DTOd ei
3 kirjutata käsitsi).
AO-N-TE-I- Punktis AO-N-TE-I-3 mainitud tööriistad ja nende parandused tuleb tarnida koos testidega.
4
7. Alusandmed AO-N-TE-A
Nõue Sisu
AO-N-TE- Alusandmete genereerimiseks vajalik peab olema vastavate testidega kaasas.
A-1
AO-N-TE- Kui testimiseks on vajalikud andmed teistest süsteemidest, siis nende saamine lepitakse eelnevalt kokku.
A-2
AO-N-TE- Alusandmed peavad töötama erinevates keskkondades, kaasa arvatud andmed, mida päritakse teistest süsteemidest.
A-3
AO-N-TE- Peab vältima teiste süsteemide andmete rikkumist, selle vältimiseks vt. punkt AO-N-TE-A-2 .
A-4
AO-N-TE- Eelistama peaks alusandmete genereerimist või eraldi üldkasutatavat kihti, millest andmed võetakse, mitte koodi sisse kirjutatud andmeid (Näiteks Isikukoodid võetakse üldisest jadast või
A-5 eraldi testandmete alamprojektist).
AO-N-TE- Võimalusel kasutada sünteetilisi, mitte reaalseid andmeid (Näiteks reaalsuses mitte eksisteerivad Isikud), eriti kui arendatavas tarkvaras on automaatseid teavitusi või muud samalaadset
A-6 (Näiteks automaatne e-mailide saatmine).
8. Koormus- ja stressitestid AO-N-TE-S
Nõue Sisu
AO-N-TE-S-1 Testide üleandmisel peab kaasa andma nendega kaasneva dokumentatsiooni, kasutatud konfiguratsiooni ning vajadusel riistvara ja arhitektuuri kirjelduse.
AO-N-TE-S-2 Kasutatud konfiguratsioon ning riistvara ja arhitektuur võiks tugevalt sarnaneda vastuvõtja test- või toodangukeskkonna riistvaraga.
AO-N-TE-S-3 Testid peavad olema üldisest konfiguratsioonist skaleeritavad: kasutajate arv, kasutajate etapilisus (ramp-up), testide ajastamine jm. on üldised muutujad või üldises konfiguratsioonis.
AO-N-TE-S-4 Igal testil peab olema konkreetne kontekst (Näiteks SLA nõue, teenuse või baasiprotseduuri jõudluse hindamine vm.).
DIREKTOR
KÄSKKIRI
Tallinn 20.05.2022 nr 51
Nõuded testimisele v1.2 ja dokumentatsiooniplaani v2 kinnitamine
Justiitsministri 18.04.2007.a määruse nr 20 „Registrite ja Infosüsteemide Keskuse põhimäärus“ § 11 lõike 1
punkti 9 alusel:
1. Kehtestan Registrite ja Infosüsteemide Keskuse (edaspidiselt RIK) nõuded testimisele v1.2 (Lisa 1)
ning dokumentatsiooniplaani v2 (Lisa 2).
2. Kõik muudatused kehtestatud nõuetes eeldavad käskkirja muutmist.
3. Käskkirja muutmiseta on lubatud arendushankes nõudeid muuta, kui on tekkinud arendushanke
spetsiifikast tulenev vajadus, kuid käskkirja muutmine ei ole ajalise piiratuse tõttu võimalik.
4. Nõuete muutmiseks tuleb esitada põhjendus muudatuste vajalikkusest ning saada kooskõlastus
arendusosakonna ning sisekontrolli ja infoturbe osakonna juhatajatelt. Kooskõlastused peavad
olema saadud kirjaliku taasesitamist võimaldavas vormis ning sisalduma koos põhjendustega
dokumendihaldussüsteemis arendushanke dokumentide kinnitamise või lepingu sõlmimise töövoos
taustainfo failide hulgas.
5. Tunnistan kehtetuks RIK direktori 05.06.2019.a käskkirja nr 77 lisa 1 „Nõuded testimisele v1.0“.
6. Tunnistan kehtetuks RIK direktori 10.02.2020.a käskkirja nr 11 lisa 2 „Dokumentatsiooniplaan“.
7. Arendused, millega alustati enne käesoleva käskkirja kehtestamist, viiakse läbi, lähtudes punktides
5 ja 6 nimetatud käskkirjades sätestatud nõuetest.
8. Kommunikatsioonijuhil koostöös arendusosakonna juhatajaga lisada kehtestatud nõuded
siseveebi.
/digitaalselt allkirjastatud/
Rivo Reitmann