Deo zbornika Uvod u softversko inženjerstvo

Dokumentacija programa

Nakon što je program testiran i verificiran, potrebno ga je dokumentirati. Dokumentacija programa sastoji se iz dva osnovna dijela:

• tehnička dokumentacija (za programe sa uskom domenom primjene, najčešće za točno određene inženjerske probleme)
• korisnička dokumentacija

Tehnička dokumentacija

Tehnička dokumentacija se sastoji iz:

• opisa problema
• opisa modela i metode rješenja problema
• dijagrama toka i listinga programa (ako je tako ugovoreno)
• postupka instalacije programa
• postupka eksploatacije programa
• test primjera sa rezultatima

Korisnička dokumentacija

Korisnička dokumentacija je namijenjena korisnicima programa, i opisuje postupak korištenja programa, kako se zadaju ulazni podaci i kako se interpretiraju izlazni rezultati.

Izvor: N. Pavković, D. Marjanović, N. Bojčetić, Programiranje i algoritmi I, Zagreb, 2005.