Tietokantasovellusten harjoitustyö - dokumentointiohje

Harri Laine - 10.9.2002

Harjoitustyössä määritellään, suunnitellaan ja toteutetaan pieni www-alustalle toteutettava tietokantajärjestelmä. Työn tuloksena syntyy kaksi dokumenttia sekä joukko ohjelmatiedostoja. Seuraavassa on hahmoteltu dokumenttien sisältö. Ohjeessa ei ole mukana sellaisia itsestäänselvyyksiä kuin kansilehti ja sisällysluettelo.
 
 


Suunnitteludokumentti


Toteutusdokumentti

Toteutusdokumentissa kuvataan aikaansaatu ohjelmisto.

JOHDANTO

 

OHJELMISTON YLEISRAKENNE

JÄRJESTELMÄN KOMPONENTIT

Selitysten tarkoituksena on auttaa ohjelmakoodin lukemista. Ohjelmakoodiin on syytä liittää kommentteja ja käyttää havainnollisia muuttujanimiä. Ohjelmaan liittyvät yleistiedot voi kirjoittaa myös ohjelmakoodin alkuun yleiskommentiksi, jolloin ne vain kerätään ohjelmakoodista dokumenttiin. 

   Ohjelmakoodit sijoitetaan dokumentin liitteiksi.

 

ASENNUSTIEDOT

KÄYNNISTYS- / KÄYTTÖOHJE

LIITTEET


Päivitetty 10.9.2002. Harri Laine