Skip to main content

Nõuded infosüsteemi dokumentatsioonile

Parima kasutajakogemuse saamiseks palume kasutada allolevat PDF faili

Nõuded infosüsteemi dokumentatsioonile

Dokumendid peavad vastama vähemalt alljärgnevatele tingimustele:

Andmemudel

Eeldus dokumendile:

Teenuste/kasutuslugude dokumentatsioon

Otstarve:

Kirjeldada andmeobjekte ja nendevahelisi seoseid

Sisu:

Andmebaasi põhjal luua andmetabelite ja -objektide seosdiagramm.

Sihtgrupp:

Tellija, peakasutajad, rakenduse administraatorid

Ajakava:

enne esimese arendusetapi algust


enne igat arendusetapi algust


igakordsel tellijale testimisse andmisel


Kirjeldada andmemudelit kontseptuaalse mudelina

interaktioone/seoseid

jah

jah

Kasutaja õiguste ja tegevuste vastavustabel

Eeldus dokumendile:

Süsteemi üldine kirjeldus

Otstarve:

Kirjeldada kasutaja rollide õigusi erinevates kasutuslugudes ja tegevustes

Sisu:

CRUD maatriks

Sihtgrupp:

Tellija äriprotsesse valdavad kontaktisikud, ärianalüütikud, süsteemianalüütikud, täitjast sõltumatud tarkvara hooldajad, arendajad ja edasiarendajad, testijad, arhitektid, projektijuhid.

Ajakava:

enne esimese arendusetapi algust


enne igat arendusetapi algust


igakordsel tellijale testimisse andmisel


Nimetada kasutaja rollid



jah


Teenuste/kasutuslugude dokumentatsioon

Eeldus dokumendile:

Süsteemi üldine kirjeldus

                        

Otstarve:

Kirjeldab detailselt üleantavaid teenuseid/kasutuslugusid.

Sisu:

Teenuste/kasutuslugude detailse kirjelduse sisuks on:

  • Tehnilised parameetrid;
  • Veateated/Hoiatused;
  • Teostatavad kontrollid;
  • Funktsionaalsuse enda põhiprotsess ja mõned sagedamini esinevad alternatiivsed protsessid (vastavalt vajadusele);
  • Üldine kirjeldus, kuidas ja kus kajastub antud teenus/kasutuslugu tervikprotsessis;
  • Nõudeid ja reegleid toetavad (sisu mõistmisele kaasaaitavad) pildid, diagrammid, tabelid, loendid
  • Andmevahetuse teenuste kirjeldus (andmete küsimine/vastuvõtmine, turvalisus, teenuse andmestik, klassifikaatorid, xml/xsd schema )
  • Protsesside UML vaated


Sihtgrupp:

Tellija äriprotsesse valdavad kontaktisikud, ärianalüütikud, süsteemianalüütikud, täitjast sõltumatud tarkvara hooldajad, arendajad ja edasiarendajad, testijad, arhitektid, projektijuhid.

Ajakava:

enne esimese arendusetapi algust


enne igat arendusetapi algust


igakordsel tellijale testimisse andmisel


Nimetada kasutuslood


jah

Arhitektuuridokument

Eeldus dokumendile:

Süsteemi üldine kirjeldus

Otstarve:

Dokumendi eesmärgiks on kirjeldada loodava süsteemi üldist ehitust. Kirjeldatakse rakenduse loogilist struktuuri, näidates ära selle kihtideks jagunemise korda. Kirjeldatakse ka füüsilist arhitektuuri, antakse ülevaade kasutatavatest tehnoloogiatest ning vahenditest.

Sisu:

Dokument peab rahuldama vähemalt alljärgnevaid sisunõudeid:
1. topoloogia, süsteemi füüsiline arhitektuur (süsteemi komponendid andmebaasiserver, rakendusserver, meiliserver jms)
2. Nõuded arhitektuurile (operatsioonisüsteem, andmebaasid, liidestused, rakendusserverid, raamistikud, teenused)

3. Nõuded käideldavusele (süsteemi soovituslikud näitajad komponentide kaupa, näiteks andmesidekiirused, kättesaadavus, andmemahud, protsessori kiirus, mälumaht, komponentide arv süsteemi osade kaupa, kettasüsteemi jõudlus jms)

4. liidesed teiste süsteemidega (x-tee, meilisüsteemid) ja sõltuvused teistest süsteemidest. Liideste kirjeldused/otstarve

5. süsteemi tehnilised (sh automaatsed) protsessid ehk töövoog – komponentide omavahelised suhtlusstsenaariumid ja koostoimimine (näiteks, mis komponent ja millal pöördub n teenuse poole)
6. kolmandate osapoolte poolt toodetud kasutatavad tarkvarad/riistvarad, mis on vajalikud süsteemi toimimiseks

Sihtgrupp:

Arhitekt, administraator, turvaspetsialist

Ajakava:

enne esimese arendusetapi algust


enne igat arendusetapi algust


igakordsel tellijale testimisse andmisel


Dokumendi esialgne versioon


jah


Seadmete ja tarkvara kasutajakesksed juhendid

Eeldus dokumendile:

Teenuste/kasutuslugude dokumentatsioon

Otstarve:

Teenuse funktsionaalsuse kasutamiseks ja kasutuslugude läbimiseks vajalikud juhised

Sisu:

Igale esitluskihile peab olema koostatud eraldi kasutusjuhend, mis kirjeldab vastava komponendi funktsionaalsuse kasutusvoo põhiselt. Kirjeldus tarkvara ja seadmete kasutamise üldisest protsessist, protsessi olulisemate sammude kirjeldus. Koostatakse projekti lähteanalüüsi aluseks võttes. Tarkvara kasutusjuhend on aluseks kasutajate koolitamisel. Kasutajajuhend kirjeldab kõiki kasutajate funktsionaalsusi koos tööprotsesside kirjeldusega ning ekraanipiltide vormis näidetega. Haldusliidese kasutusjuhend (peakasutaja ja rakenduse administraatori funktsionaalsus) peab olema eraldi tavakasutaja kasutusjuhendist.

Esitluskihi kasutusjuhendi minimaalne ülesehitus:

  • lühitutvustus
  • üldine kirjeldus koos komponentidega
  • autentimine (kui eksisteerib)
  • komponentide detailne kirjeldus koos kõikide funktsionaalsustega
  • Rollide kirjeldus ja õigused


Sihtgrupp:

Tarkvara kasutajad,  peakasutaja, rakenduse administraator

Ajakava:

enne esimese arendusetapi algust


enne igat arendusetapi algust


igakordsel tellijale testimisse andmisel




jah

Paigalduse ja administreerimise juhend

Eeldus dokumendile:

  • Arhitektuuridokument
  • Süsteemi üldine kirjeldus

Otstarve:

Juhend on aluseks süsteemi administreerimisele

Sisu:

Juhend peab rahuldama vähemalt alljärgnevaid sisunõudeid:
1. süsteemi parameetrite (seadistuste) kirjeldus ning nende muutmiste mõjud ja protseduurid. Konfiguratsioonifailide kirjeldus koos asukohtadega failisüsteemis;
2. logimise realisatsiooni kirjeldused (kuhu, mida, logide struktuur
3. rutiinsete hooldusprotseduuride kirjeldus (komponentide taaskäivituse vajadus parameetrite muutmisel);
4. paigaldamise protseduurid.

4.1 Nõuded rakenduse komponentidele

4.2 Rakenduse paigaldus (Vajalik tarkvara ja konfigureerimine, rakenduse pakkimine ja paigaldamine)

4.3 Andmete alglaadimine

4.4 Varundusskript

4.5 Monitooringu kirjeldus

Juhendis kirjeldatakse iga realiseeritud osa rakendamine (deployment) koos spetsiifiliste seadistustega. Paigaldamise protseduurid peavad olema kirjutatud selliselt (samm sammult), et süsteemiadministraator suudab rakenduse paigaldada ilma kõrvalise abita.

Sihtgrupp:

Peakasutaja, projektijuht, süsteemiadministraator

Ajakava:

enne esimese arendusetapi algust


enne igat arendusetapi algust


igakordsel tellijale testimisse andmisel




jah

Lähtekood (sh andmebaasi struktuur)

Eeldus dokumendile:

  • Arhitektuuridokument
  • Teenuste/kasutuslugude dokumentatsioon
  • Andmemudel
  • Kasutaja õiguste ja tegevuste vastavustabel
  • Prototüüp

Otstarve:

Lähtekood on vajalik selleks et kompileerida rakendust, ning võimaldada tulevikus rakenduse muutmist.

Sisu:

  • Lähtekood peab olema hästi struktureeritud, piisavalt dokumenteeritud ning võimalikult lihtne, et sellest saaksid aru ka teised arendajad.
  • Lähtekood peab vastama MFNile
  • Lähtekood peab olema pakendatud vastavalt versioonimisjuhendile.
  • Rakenduste lähtekood peab olema piisavalt modulaarne, et seda saaks tulevikus lihtsasti täiendada ning muuta.

Ajakava:

enne esimese arendusetapi algust


enne igat arendusetapi algust


igakordsel tellijale testimisse andmisel



Versioonihaldus tuleb teha Tellijakeskkonnas (nt Gitlab), sh ka jooksvaid commit’e

Koormustestide dokumentatsioon

Eeldus dokumendile:

  • Teenuste/kasutuslugude dokumentatsioon
  • Prototüüp (ainult kasutajaliidesega rakenduse puhul)
  • Arhitektuuridokument

Otstarve:

Määrata kindlaks arendusetapil testitavad kasutuslood ja liidesed (sh välja tuua need, mille puhul rakendatakse koormusteste) tuues välja nende järjekorra.

Sisu:

Järjestatud (võib olla ka paralleelne) nimekiri kasutuslugudest ja liidestest (vajadusel määrates nende ulatust) koos märkega, mis on koormustestiga tagatud ning millel on testandmed

Sihtgrupp:

Tellijapoolne projektijuht, vastuvõtutestijad

Ajakava:

enne esimese arendusetapi algust


enne igat arendusetapi algust


igakordsel tellijale testimisse andmisel


Nimetada kasutuslood, mille puhul rakendatakse koormusteste


 jah

Testimise tulemite dokumentatsioon

Eeldus dokumendile:

Koormustestide dokumentatsioon


Otstarve:

Anda tellijale ülevaade läbiviidud testimise tulemustest ning esitada soovitused testandmete ja dokumentatsiooni parendamiseks (ettevalmistus, paigaldus, kasutuslugude kirjeldus jne).

Sisu:

Teostatud arenduste testimisel saadud informatsioon (näiteks testlood, testraport, testiplaan, testide kood jms). Dokumenteeritakse iga testimise eesmärgid (testimise maht ja ulatus), tegevused ja tulemused. Sisaldab jõudlus- ja mahutestide infot ning versiooni infot. Teste mitteläbinud testlugudele on lisatud parandused või ülesjäänud vead. MFNi vastavustabel

Sihtgrupp:

Arhitekt, süsteemiadministraator, turvaspetsialist

                               

Ajakava:

enne esimese arendusetapi algust


enne igat arendusetapi algust


igakordsel tellijale testimisse andmisel




jah

Automaattestimise tulemite dokumentatsioon

Eeldus dokumendile:

Lähtekood (sh andmebaasi struktuur)


Otstarve:

Anda tellijale ülevaade läbiviidud automaattestimise tulemustest.

Sisu:

Ülevaade SonarQube’is (testide nimekiri, testide käivitamise tulemus, koodi kaetavus).

Sihtgrupp:

Arhitekt, süsteemiadministraator, turvaspetsialist

                               

Ajakava:

enne esimese arendusetapi algust


enne igat arendusetapi algust


igakordsel tellijale testimisse andmisel




jah

Taasteplaani tegemise juhend

Otstarve:

Kirjeldada erisused, millega tuleb arvestada taasteplaani loomisel

Sisu:

Taasteplaan peab rahuldama vähemalt alljärgnevaid sisunõudeid:
1. süsteemi halvamist võimaldavad riskid ja nende esinemise võimalikkus;
2. varundamisele kuuluvate komponentide ja
asukohtade loetelu (nt rakenduse konfiguratsioonifailid rakendusserverist ja andmebaas jne), nende kirjeldused ja kasutuselevõtu protseduurid;
3. süsteemi komponentide asendusvõimalused, nende alternatiivkomponentide spetsifikatsioonid

Sihtgrupp:

Arhitekt, süsteemiadministraator, turvaspetsialist, äri, tellijapoolne projektijuht

Ajakava:

enne esimese arendusetapi algust


enne igat arendusetapi algust


igakordsel tellijale testimisse andmisel




jah

Üldised nõuded:

Üleantav dokument peab sisaldama sisseviidud muudatusi nii, et on väljatoodud muutunud ja lisandunud osa (võrreldes viimati üleantuga).