1.2.3 Dokumentatsioon

iDevice ikoon 1.2.3 Dokumentatsioon

Lisaks eelnevalt vaadeldud tegevustele, vaatleme nüüd tegevuste tulemeid ja tegevuste sooritajaid.

Süsteemi nõuete dokument on nõuete kogumise ja analüüsi tegevuse väljundiks, ning sisaldab kasutajate ning huvipoolte vajadustest lähtuvat süsteemi omaduste ja piirangute kogumit. Toome näiteid nõuetest: funktsionaalne nõue on, et kasutaja saab süsteemi abil hallata klientide andmeid ja arveid, turvanõude näide on, et süsteemist peab saama andmeid kätte ainult selleks volitatud isik. Tehnoloogiline piirang on, et kasutaja peab saama süsteemiga suhelda veebilehitseja abil.

Süsteemi nõuete dokument peaks katma järgmised teemad:

  • sissejuhatus: dokumendi eesmärk, projekti ulatus, kasutatavate terminite ja lühendite seletused (nn süsteemi sõnastik), viited teistele dokumentidele, dokumendi struktuuri kirjeldus;
  • toote kirjeldus;
  • kasutajate ja huvipoolte profiilid, eesmärgid, vajadused, kogemused. Kasutajate kirjeldamine aitab paremini mõista kasutajate vajadusi ning oskusi loodava tootega ümber käia;
  • piirangud: kasutajatest või ümbritsevast keskkonnast lähtuvad piirangud, nt olemasolevate süsteemidega seostamine, arendusvahendid, õigusaktid;
  • eeldused ja sõltuvused: toote loomine võib eeldada teatud tingimuste täitmist, nt et peatselt jõustatakse õigusakt; kolmas osapool loob liidestatava süsteemi;
  • käitluskeskkond - kirjeldab platvormid, millel toode peab töötama, sh operatsioonisüsteemid, riistvaraplatvormid, andmebaasimootorid, veebiserverid, rakendusserverid, monitooringuliidesed jms;
  • kõikide funktsionaalsete ja tehniliste (turva-, kasutatavus- jm) nõuete detailne kirjeldus, sh kasutuslood ja UML kasutuslooskeemid.

Nõuete dokumendi koostab analüütik koostöös tulevaste kasutajatega.

Arhitektuurse disaini dokument kirjeldab süsteemi ülesehitust, süsteemi komponente ning mooduleid, liideseid komponentide vahel ja liideseid teiste süsteemidega. Kirjeldatakse ka füüsiline arhitektuur - riistvara ja näidatakse, milline tarkvara komponent millisele riistvarale paigutatakse.

Arhitektuurse disaini dokument peaks katma järgmised teemad:

  • sissejuhatus: dokumendi eesmärk, viited teistele dokumentidele, dokumendi struktuuri kirjeldus;
  • arendusvahendite valiku ja häälestuse, arenduskeskkond;
  • kodeerimise, sh kommenteerimise ja nimetamise standardid;
  • liidesed teiste süsteemidega, andmevahetusformaadid ja meetodid;
  • toote sisemise struktuuri, ülesehituse: süsteemi jaotuse komponentideks, komponentide kohustused ja rollid, komponentide andmevahetus;
  • arhitektuuriotsuste tausta, alternatiivid, valikukriteeriumid;
  • jõudlusnõuded. Väljendatakse viisil, mida on võimalik testimise käigus kontrollida;
  • suhtlusviisid kasutajatega, vigade kuvamise viisid;
  • ressursinõuded, st kui palju toode nõuab mälu, arvutusvõimsust jms;
  • turvalisuse tagamise meetmed;
  • porditavus, so võimalus käitada tarkvara erinevatel platvormidel.

Süsteemi nõuded ja arhitektuursed otsused peavad olema omavahel ristviidatud, st vajadusel on võimalik mingi nõude muutmisel muuta temaga seotud arhitektuurilisi lahendusi, ning vastupidi - mingi arhitektuuriotsuse muutmisel nt rahalistel põhjustel leida, milliseid nõudeid selline muutmisotsus puudutab.

Arhitektuurse disaini dokumendi koostab arhitekt lähtudes nõuete dokumendis toodud nõuetest.

Kasutajajuhend on dokument, milline käsitleb kasutaja vaadet süsteemile - milleks toodet saab kasutada, kuidas toodet kasutada, millised on võimalikud veasituatsioonid ning nende lahendamine. Kasutajajuhend ei vaatle süsteemi „sisemust" vaid seda, mis on kasutajale nähtav.

Projektidokumentatsioon käsitleb projektijuhtimisega seotud materjale.

Haldusjuhend käsitleb toote installeerimist, andmesiiret, toote hooldust ja administreerimist, konfigureerimist, muudatuste sisseviimise korda.