No, i sto si dosad napravio? Sto ti konkretno nije jasno?
P.S. Tko za ime svijeta pise programsku dokumentaciju u Wordu?!
Ja, recimo ne pišem u Wordu al pišem u OneNoteu, tipa ovako nešto.. Nije C++ al je PAWN
Uz to računaj da sam tek na početku projekta i da ima ohoho rada na istome.
Ovo prikazano više liči na tehničku nego li na korisničku (programsku) dokumentaciju. Međutim, da meni netko preda tehničku dokumentaciju projekta na ovakav način ona bi odmah bila vraćena na doradu iz sljedećih razloga:
1. Nema konceptualnog ER modela baze podataka
2. Prikazani popis tablica i kolona djelomično liči na logički ER model, ali opet bez prikazanih odnosa među pojedinim entitetima
3. Nema relacijskog modela baze podataka s jasnim opisom pojedinih veza (kaskada, NULL ili nešto treće?)
4. Imena tablica moraju biti jasnija, ili ih se bar po shemama u tu svrhu trebaju grupirati
5. Ovako na prvi pogled vidim da čak niti model (struktura prve tablice) nije dobro napravljena jer ako ništa drugo prikazana tablica nije u 3NF
Za točku br.1 preporučujem primjerice Enterprise Architecht. On se može upotrijebiti i za točku 3, nakon čega se direktno iz Enterprise Architecta mogu generirati sve tablice i relacije direktno u samoj bazi. Što se tiče ovog popisa on se može napisati i u Excelu (npr. svaki sheet za svoju tablicu). Pošto je to tehnička dokumentacija ona je samo za određenu grupu ljudi i najbitnije je da je dobro organizirana. A što se tiče korisničke dokumentacije tu se može npr. ovo što je Domagoj spomenuo (doxygen) i sl. Obavezno linkati dijelove aplikacije (kontrole) preko context id-eva i na taj način direktno prikazati korisničku dokumenaciju za konkretni upit.
Pokazao bih sada neke primjere (upravo završio s modeliranjem i dokumentiranjem baze podataka za jedan EU projekt od 1.000.000 kn), kao i aplikacije koju sam u tu svrhu napisao, te i za nju također napisao tehničku pa zatim i korisničku dokumentaciju. No, mislim da ne smijem to baš javno pokazivati, tako da..