Izrada dokumentacije

     

 

Prilikom razvijanja programa potrebno je voditi detaljne bilješke o svakoj pojedinoj etapi. Unutar samog programa dobro je pisati komentare za dijelove programa koje je bilo teško osmisliti i realizirati programskim jezikom. Sve te bilješke potrebno je sakupiti. One čine dokumentaciju koja će biti od velike pomoći prilikom dodatnih zahvata na programu.

Osim dokumentacije za programera bitno je napraviti i upute za korisnike (od instalacije programa, do objašnjenja svake pojedine opcije).

Prema prikazu na slici,dokumentacija programa izrađuje se u dva dijela. Prvi dio je uputa korisniku. Njome se korisnik upoznaje s načinom instalacije i korištenja programa. Tu dokumentaciju predajete naručitelju zajedno s programom.

Drugi dio dokumentacije izrađujete za svoje potrebe. Sasvim je realno očekivati da će nakon određenog vremena naručitelj programa od vas tražiti da nešto u programu promijenite. Nakon što je od izrade programa prošlo neko vrijeme nije se jednostavno točno sjetiti svih sitnica, načina rješavanja i problema na koje ste nailazili tijekom pisanja.

Zbog toga u dokumentaciji treba biti potpuna analiza zadatka, skica rješenja i algoritam. Bilo bi poželjno navesti s kojim problemima ste se susretali tijekom izrade programa i na koji način ste ih riješili.

U dokumentaciji treba opisati postupak testiranja i navesti ograničenja programa.

Dokumentacija sadržava i sve izmjene koje ste morali napraviti u odnosu na početni algoritam i zahvate u kôdu koje ste naknadno napravili.

Bilo bi dobro prilikom kodiranja koristiti što više komentara kojima objašnjavate što se u određenoj funkciji radi.

Ako se pridržavate ovih preporuka izmjene programa vam čak i nakon nekoliko godina ne bi trebale predstavljati problem.

Ovdje možete pogledati primjer dokumentacije izrađene za rad predstavljen 2006. godine na Državnom natjecanju iz informatike.

Program je završen, testiran i predan naručitelju. No, tu nije kraj rada na njemu. Svaki program zahtjeva nadogradnju i održavanje. Održavanje programa je sljedeća i posljednja lekcija ovog poglavlja.