Dokumenteerimis alused

Dokumentatsiooni liigid

Minu erialaga on seatud järgmised liigid.

Seadused,stantardid;
Reeglid,regulatsioonid,juhendid;
Käsiraamatud,juhendid,tutvustused(Giidid);
Posterid;

  

Tarkvaraprojektiga ja arendavate süsteemidega seotud domkumendid on seotud terve rea nendega seotud nõutega.

Need dokumendid annavad vajalikku infot tarkvara arenduse protsessi juhtimiseks,kavandamiseks eelarve koostamiseks ja arenduseks vajaliku aja arvestamiseks.

SRS-
SDD-
STD-
SPDM-Sprint
Dokumentide sisu ja vastutajad
Tarkvarainsenerid 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
2.Toote dokumentatsioon

Protsessi ja toote dokumentatsioon

Protsessi dokumentatsioon koostatakse selliselt,et süsteemi arendust saaks hallata.Toote dokumentatsiooni kasutatakse pealse süsteemi tööle hakkamist(Siis,kui süsteem töötab) kuid see dokumentatsioon on oluline ka süsteemi arenduse staadiumis, et hallata arendusprotsessi.

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
2.Süsteemi dokumentatsioon

Süsteemi dokumentatsioon

Nõuete dokument ja sellega seotud aluspõhimõtted.
Dokument mis kirjeldab süsteemi ülesehitust
Iga süsteemi programmi kohta selle programmi ülesehituse kirjeldus.
Iga süsteemi osa kohta.
Programmikoodi loetelud
Õigsuspärasuse dokumendid
Süsteemi hooldusjuhend

Table of contents - sisukord
List of illustration -
Introduction - sissejuhatus
Concept of operation

Juhendi osad
Tiitel
Märkused
Sisukord
Sissejuhatus
Iseärasused
Paigaldamine
Lisade paigaldus
Lisad

SDD

Selle juhendi eesmärk on aitada kuidas teha korralik juhend mis seletab kuidas mingi program töötab ja kuidas seal asju teha.
Seal oli näitisna tootud mingi telefoni rakendus mida saab kasutada, et pilde ja muid faile leida.