Dokumenteerimise alused

Dokumenteerimise alused

08.10.2014

Minu tööga on seotud sellised dokumentatsiooni liigid:

1.Seadused, standardid
2.Reeglid, regulatsioonid, juhendid
3.Käsiraamatud, juhendid, tutvustused (giidid)
4.Postrid

Postri näide:

https://www.google.ee/search?q=poster&client=firefox-beta&hs=A5U&rls=org.mozilla:en-US:official&channel=fflb&source=lnms&tbm=isch&sa=X&ei=TAk1VLuwDOXm7gbD6oD4Dw&ved=0CAgQ_AUoAQ&biw=1920&bih=938#rls=org.mozilla:en-US:official&channel=fflb&tbm=isch&q=software+development+process+poster&spell=1&facrc=_&imgdii=_&imgrc=jMAtGIoxu1ORuM%253A%3B_1oWKVYKEuasnM%3Bhttp%253A%252F%
252Fwww.canon.com%252Ftechnology%252Fcanon_tech%252Fexplanation%252Fimages%
252Fcp_tech_ph030.gif%3Bhttp%253A%252F%252Fwww.canon.com%252Ftechnology%
252Fcanon_tech%252Fexplanation%252Fcp_tech.html%3B580%3B338

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

1.Need dokumendid on arendusmeeskonna suhtluskeskkonnaks
2.Need dokumendid on süsteemi info andmeallikaks,mida kasutavad hooldusinsenerid
3.Need dokumendid annavad vajalikku infot tarkvara arenduse protsessi juhtimiseks
4.Mõned neist dokumentidest peavad andma infot kasutajatele, kuidas süsteemi kasutada ja hallata.

SRS
SDD
STD
SPMD -> sprint (2 nädalat)
         backlog

Eelpool toodud dokumentide jaoks on vaja ka teha teisi dokumente (kasutusjuhendid jne).

Tarkvarainsenerid (tarkvaraarendajad) vastutavad tavaliselt enamiku dokumentide ettevalmistamise eest (dokumentatsiooni loomise spetsialistid võivad ka neid selles aidata: sisu, ülesehitus jne).

http://senior.ceng.metu.edu.tr/2013/puzzle/downloads.html

Laias laastus jaguneb dokumentatsioon 2 liiki või klassi:

1.Protsessi dokumentatsioon
2.Toote dokumentatsioon

Protsessi dokumentatsioon koostatakse selliselt, et süsteemi arendust saaks hallata. Toote dokumentatsioon kasutatakse peale süsteemi tööle hakkamist (siis kui süsteem töötab). Kuid see dokument 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 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

Töö käigus tekkiv dokumentatsioon (Working papers).
Tavaliselt on need peamise tehnilise suhtlemise dokumendid,mis projekti käigus tekkivad. Väga sageli kirjeldavad nad tehtud disaini otsuste aluspõhimõtted ja põhjendusi.

Memod ja elektronkirjad kirjeldavad protsessi haldurite (projektijuhtide) ja arendusinseneride igapäevase suhtluse üksikasju.

Toote dokumentatsioon:

Süsteemi hindaja (vajab funktsionaalset kirjeldust)
Süsteemi admin (vajab paigaldus juhist)
Vähekogenud kasutajad (vajab sissejuhatavat juhendit)
Kogenud kasutaja (vajab viitelist juhendit)

Suurte süsteemide korral, millised on arendatud kasutjanõuete põhjal (või vastavalt neile), peaks süsteemi dokumentatsioon sisaldama:

1.Nõuete dokument ja sellega seotud aluspõhimõtted (olemasolu, vajaduse põhjendus) SRS
2.Dokument, mis kirjeldab süsteemi ülesehitust (system architecture) SDD
3.Iga süsteemi programmi kohta selle programmi ülesehituse kirjeldus (architecture)
4.Iga süsteemi osa kohta tema ülesannete kirjeldus ja liidesed (functionality and interfaces)
5.Programmikoodi loetelud
6.Õiguspärasuse dokumendid
7.Süsteemi hooldusjuhend

IEEE standard kasutajate dokument

Identification data Dokumendi osad:

Table of contents Tuvastuskood

List of illustrations Sisukord:

Instroduction Loetelu

Information for use of the documentation Sissejuhatus

Concpect of operations Kuidas seda dokumenti kasutada

Procedures Protsetuurid

Information on software commands Ülevaade tarkvara käsklusest

Error messages and problem resolution Veateated ja probleemi lahendus

Glossary Sõnastik

Related information sources Infoallikad

Navigational features

Index
Search capability

SRS dokument sisukord

1.Sissejuhatus
1.1 Eesmärk
1.2 Dokumendi konvektsioon
1.3 Ettepanekud
1.4 Projekti ulatus
1.5 Viited

2.Üdine kirjeldus
2.1 Toote perspektiiv
2.2 Toote omadused
2.3 Kasutaja klassid ja omadused
2.4 Töökeskkond
2.5 Disaini ja rakendamise piirangud
2.6 Eeldused

3.Süsteemi funktsioonid
3.1 Profiili loomine
3.2 Logi sisse
3.3 Logi välja
3.4 Profiili uuendamine
3.5 Värskendamine
3.6 Kategoriseerimine
3.7 Otsimine
3.8 Kasutaja otsimine
3.9 Muud kasutajate profiilid
3.10 Sõnumid
3.11 Kommentaari lisamine
3.12 Jagamine
3.13 Laenamine

4.Nõuded
4.1 Kasutajaliidesed
4.2 Riistvara liidesed
4.3 Tarkvara liidesed
4.4 Kommunikatsiooni liidesed

5.Muu
5.1 Funktsionaalsed nõuded
5.2 Jõudluse nõuded
5.3 Ohutusnõuded
5.4 Turvalisuse nõuded
5.5 Tarkvara oskused

Kuulata 22.veebruar Restart: Codeborne kasvatab oma programmeerijad ise.

Juhendi osad:

1.Tiitel
2.Märkused
3.Sisukord
4.Sissejuhatus
5.Iseärasused
6.Paigaldamine
7.Lisade paigaldus,paigaldusjuhendid
8.Lisad

Tarkvara juhendi osad:

1.Sissejuhatus

2.Ülevaade

3.Kasutamisjuhised

4.Töötamisviited

5.Lisad

SDD-Sofware design description

1.Sissejuhatus

1.1 Eesmärk

1.2 Ulatus

1.3 Ülevaade

1.4 Lisamaterjal

2.Süsteemi ülevaade

2.1Probleemi kirjeldus

2.2Kasutatavad tehnoloogiad

2.3Toote ülevaade

3.Süsteemi arhitektuur

3.1Arhitektuuri projekteerimine

3.2Lagunemise kirjeldus

4.Andme diagramm

4.1 Andmete kirjeldus
4.2 Andmete

5.Komponentide disain
5.1 Serveri komponendid
5.1.1 Andmebaas
5.1.2 Serveri klass
5.2 Kliendi komponendid
5.2.1 Otsinguleht
5.2.2 Albumi leht
5.2.3 Profiili leht
5.2.4 Sisselogimis leht
5.2.5 Sõnumite leht
5.2.6 Serveri ühendamine

6.Disain
6.1 Ülevaade kasutajaliidesest
6.1.1 Sisselogimise leht
6.1.2 Regristri leht
6.1.3 Profiili leht
6.1.4 Albumi leht
6.1.5 Sõnumi leht
6.1.6 Otsinguleht
6.2 Ekraanil olevad objektid ja toimingud
6.2.1 Sisselogimise leht
6.2.2 Regristri leht
6.2.3 Profiili leht
6.2.4 Albumi leht
6.2.5 Sõnumi leht
6.2.6 Otsinguleht

7.Nõuded maatrix-i jaoks