Tarkvaraarenduse projekt

Allikas: Teadmusbaas

Üks korralik tarkvaraarenduse projekt sisaldab erinevaid dokumente, millised on seotud tarkvaraprojekti juhtimise, teostamise (töö tehniline kirjeldus) ja testimisega, uuri lähemalt standardit ISO/IEC/IEEE 16326:2009 ja IEEE 1058 (vana, eelmine versioon).

Tarkvara arendusprotsessiga seotud IEEE standardid

Tarkvara arenduse dokumentatsioon jaguneb protsessi dokumentatsiooniks ja toote dokumentatsiooniks

Protsessi dokumentatsioon (näiteid vaata allikas 1):

  1. Visioon - seab projekti suuna ja ulatuse ning määratleb, mida on vaja saavutada
  2. Projekti harta - määratleb projekti ulatuse, annab põhjenduse ja otstarbekuse ning kui projekt heaks kiidetakse või kinnitatakse, siis arendatakase temast projektiplaan.
  3. Tarkvara nõuete määratlus (SRS) - loetleb funktsionaalsed ja mittefunktsionaalsed nõuded koos realiseerimispiirangutega. See dokument on mõeldud suurele hulgale erinevatele kasutajatele alates lihtsatest kasutajatest kuni programmeerijateni välja. Dokument on kasvava keerukuse astmega ja süsteemi käitumine on tihti kirjeldatud kasutuslugudega. Kuidas kirjutada SRS?
  4. Tarkvaraprojekti halduskava (SPMP) - on tarkvaraprojekti juhtimise kava projektijuhi vaatevinklist, milline areneb koos projekti enda arenguga ja seetõttu võib lõplik versioon oluliselt erineda algsest, sest ainult erandina käivituvad mõned projektid kogu vajaliku infoga.
  5. Uue toodangu väljalaskmise (Release) kava - on peaaegu võrdne agiilse arenduse iteratsioonide ajakavaga
  6. Iteratsiooniplaan - määratleb tegevused, millised teostatakse iteratsiooniga (ühe väljatöötamise (koodi kirjutamise) tsükliga), koostakse iga iteratsiooni jaoks eraldi iga uue iteratsiooni alguses
  7. Mõistmise memo - on vähem formaalne dokument oletustest ja kavatsustest, suulised kokkulepped vormistatkse tihti selliseks memoks.
  8. Projekti edutegurid (kriteeriumid) - kirjeldavad, kuidas projekti mõõdetakse ja määratleb mõõdikud ning tähtajad
  9. Projekt lõpparuanne - kokkuvõte ja projekti meetrikad
  10. Muudatusnõue - sisaldab muudatusettepaneku kirjeldust, põhjendust, prioriteetsust jne etteantud vormil, vt Muudatusnõude vorm
  11. Muudatuste halduse logi - sisaldab tehtud muudatuste loetelu, vt Muudatuste logi vorm
  12. Iseärasuste logi, sisaldab iseärasuste loetelu, vt tarkvara iseärasuste logi mall
  13. Tarkvaraprojekti seisundi aruanne - on mõeldud huvigruppidele info andmiseks, vt seisundiaruande mall

Toote dokumentatsioon (näiteid vaata allikas 1):

  1. Toote ülesehitus (Architecture) ja disain - see dokument selgitab koodi ülesehitust ja hästi koostatud dokument annab projektiga liituvale uuele programmeerijale võimaluse kiiresti projekti koodi mõista muudatuste ja parenduste tegemiseks. Ülesehituse/disaini dokument peaks tuvastama süsteemi peamisi osi ja kirjeldama nende staatilisi omadusi ning dünaamilisi suhtluse mustreid. Tavaliselt ta koosneb UML mudelitest (kõige tavalisemad on klassiskeemid ja järgnevusskeemid) ja kirjeldavast tekstist, andmevoogude skeeme kasutatakse andmete liikumise kirjeldamiseks süsteemis. Kuna ülesehitus on kõrgema taseme disain, siis võib dokumente sõltuvalt mahust olla 1 või on ülesehituse ja disaini dokumendid eraldi.
  2. Koodistandardid
  3. Testiplaan
  4. Testi määratlusdokument
  5. Kasutajajuhend (User Guide) tarkvaratoote kasutamine kasutaja perspektiivis
  6. Süsteemi dokumentatsioon sisaldab paigaldusjuhendit, juhendit administraatorile jne

Loe lisaks tarkvaratoodete dokumenteerimise kohta

Allikad:

  1. Tarkvara dokumentatsiooni mallid
  2. Projektijuhi mallid

⇐ Tagasi agiilse metoodika mooduli juurde
⇐ Tagasi tarkvara arendusprotsessi mooduli juurde