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.
On olemas erinevaid tüüpe dokumentatsioone, aga tüüpiliselt esinevad vähemalt järgnevad:
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.
Sissejuhatus kirjeldab ära dokumendi eesmärgi (Milleks ja kellele), projekti ulatuse (Mida arendatakse, mida mitte)
Terminite sünastik (Mittearendajale kirjeldamaks kasutatud tehnoloogilise termineid), biiteid teistele
dokumentidele ( erinevad uml diagrammid, kasutusjuhendid, meeskonna arenduse halduskeskkond, projekti-
juhtimise halduskeskkond, Arendatava töö enda haldusjuhend, jpm)
Kirjeldab arendustööd ennast mida selle dokumendi abil arendama hakatakse/arendatakse
Kirjeldatakse ära mida tahab kasutaja teha, mida kilent sellest saab, mis on nende erinevad vajadused,
kas neil on eelnevaid kogemusi sarnaste toodetega samast tootekatekooriast. Näiteks rollipõhine tabel sotsiaalmeedia
äpi jaoks:
| Roll | Tegevused |
| Külaline |
|
| Registeeritud kasutaja | Kõike mis külaline +
|
| Admin | Kõike mis registeerinud kasutaja +
|
| Süsteemi administraator | Hoolitseb veebiäpi toimimise eest, haldab andmebaase, teeb korrastustöid, vajadusel konfigureerib ja jälgib muud statistikat, et tagada kliendi ja kasutajate rahulolu. |
Kirjeldtakse ära erinevad piirangud või tõkestavad aspektid, mis võivad arendusel ette tulla, kasutajatel endal olla
Keskkonnast kus toode toimima peab, arendusvahenditest tulenevad piirangud ja seaduslikud piirangud.
Toote loomist võib tingida mingisugune eelnev tingimus - viiakse sisse riigisüsteemis mingisugune muutats, digitaalne
vahend selle jaoks puudub, ning leitakse et on vaja arendada vastav tööriist et tagada riigisüteemi muudatuse ülalhoid.
Kirjeldab ära keskkonna riistvaraliselt millel arendatud tarkvara toode toimima peab. See võib endas sisaldada erinevaid:
Kirjeldab ära erinevadd funktsionaalsed nõuded (Näiteks sisselogimisfinktsioon backendis) kasutajalugudena ning muud tehnilised
nõuded arenduskeskkonnas. Sisaldab ka endas erinevaid UML skeeme.
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.
Kirjeldatakse ära dokumendi eesmärk (milleks ja kuidas), viidetakse muudele dokumenditele (seal hulgas Tarkvara nõuete dokument),
ning omab sisukorda.
Kirjutatakse välja milliseid arendusvahendeid on otsustatud arendustööks rakendada. Kirjeldatakse ära ka nende seadistus
ja põhjustadakse ära miks just need arendusvahendid valitud on. Kirjeldatakse samamoodi ära ka peale arendusvahendite.
arenduskeskkond.
On kokkuleppeliselt konventsioonid mida kogu arendusmeeskond jälgima peab, nendeks on:
Kirjeldatakse ära teised, välised süsteemid ja kuidas nendega arendatav tarkvaratoode suhtlema peaks.
Sealhulgas ka mis kujul ja mis viisil need välised süsteemid infod vastu võtavad, ja taagasi annavad.
Kirjeldatakse ära kuidas arendaatav toode sisemiselt erinevateks komponenditeks jaotub, ning milline on
selle üldine sisemine struktuur. Mida iga komponent tegema peab, mis on selle komponendi eesmärk
ja kuidas komponendid omavahel suhtlevad.
Siin tuuakse välja, miks miski arhitektuuriotsus langetati, ehl miks jusy nii mitte naa. Pakutatakse välja ka olemasolevatele otsustele alternatiive juhuks kui esialgne plaan ei sobi või on tõkestatud.
tuuakse välja ka nõuded mille põhjal erinevad otsused langetati, ehk mida see otsus lahendama peaks.
Pannakse kirja tarkvaratootele kilendi poolt esitatud jõudlusnõuded, näiteks: kui palju kasutajaid suudab
sotsiaalmeedia platvorm korraga hallata. Testimise käigus üritatakse testida arendusjärgus olevat toodet
simuleeritud koormus Kõik muud jõud.usnõuded peaksid olema ka testitavad sellisel viisil.
Kuidas programm väljendab oma funktsionaalsust lõppkasutajale ja millisel viisil esitatakse programmis
tekkinud vigu *kasutajale*. Ehk teisi sõnu on siin ka kasutajaliidese disain. Kasutajaliidese disain võib olla
ka eraldi oma dokument.
kirjeldab ära kui palju vajab arendatav toode erinevaid süsteemi raudvara ressurse nagu:
Kuidas ja mis viisidel hoitakse lõppkasutaja andmed ja raudvara terve ja turvalisena niing tehakse kindlaks
et lõppkasutaja saaks kätte ainult need andmed mida tal programmis oleva tegevuse teostamiseks vaja on
Näiteks krüpteeritakse tundlikud andmed andmebaasi esmasel sisestusel ära, ning iga järgmine kord
võrreldakse kasutaja sisestusi (nagu parool jms) andmebaasis juba oleva krüpteeritud kujuga.
Kas programm on võimalik käivitada teistel (niiriistvaralisel kui tarkvaralistel) platvormidel, ja kui
siis millistel.
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.
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 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:
On omakorda dokumendiartefaktide kogum, mis käsitleb projekti haldamisega seotud dokumente, sh. ajakava planeerimist, arendusega
seotud ressursside planeerimist, arendustöö hetkejärku jms.