Dokumentatsiooni

Allikas: Teadmusbaas

Tarkvaraarenduse dokumentatsioon ja selle koostamise reeglid

Tarkvaraprojekti dokumentatsioon

Tarkvaraprojektiga ja arendatavate süsteemidega seotud dokumendid on seotud terve rea nendega seotud nõuetega:

  1. Need dokumendid on arendusmeeskonna suhtluskeskkonnaks (kõik vajalik süsteemi/tarkvara loomiseks peab neis olemas olema);
  2. Need dokumendid on süsteemi info andmeallikaks, mida kasutavad hooldusinsenerid;
  3. Need dokumendid annavad vajalikku infot tarkvara arenduse protsessi juhtimiseks, kavandamiseks, eelarve koostamiseks ja arenduseks vajaliku aja arvestamiseks (ajagraafikute koostamine);
  4. Mõned neist dokumentidest peavad andma infot kasutajatele, kuidas süsteemi kasutada ja hallata.

Dokumentide sisu ja vastutajad:

  • Eelpool toodud nõuete rahuldamiseks on vaja erinevaid tüüpi dokumente alates informeerivatest dokumentidest kuni spetsialistide (proffide) kasutajajuhenditeni.
  • Tarkvarainsenerid (tarkvara arendajad) vastutavad tavaliselt enamiku dokumentide ettevalmistamise eest, kuigi ka tehnilise dokumentatsiooni loomise spetsialistid võivad siin aidata neid dokumente siluda ja lihvida, et anda neile vajalik sisu, ülesehitus ja kuju.

Kaks dokumentatsiooni liiki:

  1. Protsessi dokumentatsioon. Need dokumendid kirjeldavad (salvestavad, esitavad) arendus- ja hooldusprotsessi. Siia kuuluvad plaanid, ajagraafikud, protsessi ja organisatsiooni kvaliteedi dokumendid ja projekti standardid ning standarditest tulenevad dokumendid.
  2. Toote dokumentatsioon. Need dokumendid kirjeldavad arendatavat toodet. Süsteemi dokumentatsioon kirjeldab toodet süsteemi arendus- ja hooldusinseneride seisukohalt (vaatenurgast lähtuvalt); kasutajadokumentatsioon annab tarkvaratoote kirjelduse, mis on orienteeritud süsteemi kasutajatele.
Protsessi ja toote dokumentatsioonid:

Protsessi dokumentatsioon koostatakse selliselt, et süsteemi arendust saaks hallata. Toote dokumentatsiooni kasutatakse peale süsteemi tööle hakkamist (siis, kui süsteem töötab) kuid see dokumentatsioon on oluline ka süsteemi arenduse staadiumis, et hallata arendusprotsessi. Sellise dokumendi nagu näiteks süsteemi iseärasused (specification) loomine on tähtis verstapost tarkvara arendusprotsessis.

Protsessi dokumentatsioon

Protsessi dokumentatsioon jaguneb järgmisteks liikideks:

  1. Plaanid, teostushinnangud ja ajakavad;
  2. Aruanded;
  3. Tööstandardid;
  4. Töödokumentatsioon (töö käigus tekkiv);
  5. Memod ja elektronkirjad.
Toote dokumentatsioon
  1. Kasutajate dokumentatsioon (erinevad juhendid ja kirjeldavad dokumendid)
  2. Süsteemi dokumentatsioon

Lingid:

  1. IEEE tarkvara arendamise standardid

Tagasi hajusrakenduse mooduli lehele