Tagasi

Mis on dokumentatsioon


Tarkvaraarenduse elutsüklis on olemas erinevaid tegevusi, nende tegevuste tulemusel tekib hulk artifakte
mis dokumenteerib nendes tegevustes kas siis tehtavaid tegevusi või tehtud tegevusi ja nende tegijaid.
dokumentatsioon tekib peaaegu igas Tarkvaraarenduse elutsüklis etapis ja põhimõtteliselt igas tarkvara-
arenduse elutsükli tüübis. Need artifaktid kokku moodustavadki Tarkvara dokumentatsiooni.



Milliseid artefakte dokumentatsioonis esineda võib?


On olemas erinevaid tüüpe dokumentatsioone, aga tüüpiliselt esinevad vähemalt järgnevad:



Mida need endast kujutavad ning mis on nende eesmärk?


Süsteemi nõuete dokument


Kujutab endast erinevates arendustsüklites oleva Analüüsietapi väljundit, kus pannakse paika
arendava süsteemi erinevad nõuded koostöös lõppkasutajatega ning kliendiga. Arvestatakse mõlemi vajadsui
ning selgitatakse välja erinevad tõkendid.


Dokumendi eesmärk on anda arendajaile Arhitektuurse disaini dokumendi loomise jaoks täpne sisend selle kohta
mida üldse arendama peab, selle abil kirjeldatakse juba süsteemselt arendajale vajalikke info.


Mida süsteemi nõuete dokument endast sisaldama peab?





Arhitektuurse disaini dokument


Kujutab endas aredatava toote või süsteemi sisemist ülesehitus. Kirjeldab ära ka selles süsteemis esinevaid erinevaid
mooduleid, komponente nin g muid sõltuvusi. Pannakse kirja ka kuidas need komponendid/moodulid omavahel suhtlevad ning süsteem
ise tervikuna suhtleb süsteemiväliste elementidega (muud liidesed/äpid/riistvarad/jne). Ära kirjeldatakse ka
arhitektuur keskkonnale kus ja kuidas valminud toode (või selle süsteemi erinevad osad) hiljem olema peab(/peavad).


Dokumenti eesmärk on tekitada arendajaile struktuur mida nad arendama hakkavad, see struktuur tuletatakse tarkvara
nõuete dokumendist. Dokumendi koostab süsteemiarhitekt.


Mida arhitektuurse disaini dokument endas sisaldama peab?


Muudatuste tegemine


Kui klient otsustab, et nüüd on tarkvara nõuete dokumendi mingi nõue vaja ringi teha, siis tuleb vastavad muudatused sisse
viia ka arhitektuurse disaini dokument. Sellel eesmärgil on mõlemis dokumendis nõuete ja arhitektuurielementide vahel ristviide
Kui on vaja näiteks sisselogimisfunktsiooni muuta, et nüüd klient tahab ka saada telefoninumbrit 2FA läbiviimiseks, siis on seal
nõude juures ka ristviide vastavale programmi moodulile, mis haldab kasutaja sisselogimist. Sellele kasutajaloole lisatakse
telefoninumbri küsimine, ja juurdelisatud osa läheb arendusse uue inkremendina.
Ning vastupidi, kui arhitektuuris tuleb välja, et telefoninimbri küsimine ei ole võimalik, siis on selles dokumendis vastav ristviide
tarkvara nõudele, ja seal defineeritakse nõue ringi, et telefoninumbri kohe küsida ei saa, tehakse uus nõue mis lubab kasutajal
selle telefininumbri hiljem lisada.


Kasutaja juhend


On dokument mis aitab lõppkasutajall kasutada ning navigeerida valminud tootes. Ta kirjeldab ära kuidas erinevaid tegevusi sooritada,
milleks seda programmi üldse kasutada saab, kuidas lahendada Korduma Kippuvaid Küsimusi ja mui võimalikke kasutaja tegevusi tagajärjel
tekkinud veaolekuid. Kasutajajuhend on kirjutatud selle põhjal mis on kasutajale näha ning saadavalm aga mitte käsitledes programmi-
siseseid detaile. Näiteks monteerimissprogramm kirjeldab kasutajale kuidas muuta tööriist nähtavaks läbi "View > Window" menüü, aga mitte
seda, millist muutujat muuta vaja, et kuvada see aken koodis (bool is ToolVisible = false; -> bool isToolVisible = true).


Haldusjuhend


Haldusjuhend on dokument mille koostavad arendajad oma arendatava toote kohta potensiaalselt arendusega mittetegelevale isikule, aga
kes on kliendi palgal valminud süsteemi hooldamas. Dokument käsitleb:


Projektihaldusdokumentatsioon


On omakorda dokumendiartefaktide kogum, mis käsitleb projekti haldamisega seotud dokumente, sh. ajakava planeerimist, arendusega
seotud ressursside planeerimist, arendustöö hetkejärku jms.