Tietokannan dokumentointi
Tiivistelmä:
- Luo dokumentaatioon asiaanliittyvät kaaviot ja kappaleet:
- Sijoita uudet kappaleet samaan pdf-tiedostoon kuin aikaisempikin dokumentaatio
Pidä mielessä!
Laita kaikki uusi dokumentaatio kootusti yhteen dokumentaatio.pdf-tiedostoon docs-kansiossa. Ohjaajasi ei halua arvuutella mistä tiedostosta dokumentaatio löytyy.
Tee lista kunkin kaavion tietokohteen sisältämistä tietokentistä, niiden tyypeistä ja rooleista sovelluksessa. Liitä kenttien kuvaukset taulukkoina dokumentaatioon. Myös yhteydet toisiin kohteisiin täytyy määritellä. Lopputuloksen kuuluu näyttää tämäntapaiselta:
Tietokohde: Kissa
Attribuutti Arvojoukko Kuvailu Nimi Merkkijono, max. 80 merkkiä Kissan nimi Väri Merkkijono, max. 30 merkkiä Kuvaus kissan väristä esim. “valkotäplikäs oranssi” Viim. ruokkimis-pvm. Päivämäärä Koska kissa on viimeksi ruokittu? Lisätiedot Merkkijono, max. 255 merkkiä Kuvaus kissan ominaisuuksista esim. “Serafiina syö vain kalaa.” Kissa, joka asuu kissatädin kartanossa. Jokainen kissa kuuluu tasan yhteen kissarotuun. Jokaisesta kissasta merkitään ylös sitä viimeksi ruokkinut palvelija.
Relaatiotietokantakaavio
Tee lopuksi suunnittelemastasi tietosisällöstä dokumentaatio-ohjeen mukainen relaatiotietokantakaavio: 
Muista lisätä kaavioon kaikki olennaiset viiteavaimet sekä monesta-moneen suhteiden tilalle välitaulut.
Tallenna tekemäsi kaaviot ja uusi sisältö repositoriosi samaan dokumentaatiotiedostoon missä edellisetkin dokumentaatiot olivat. Lisää myös kaavioiden tuottamiseen käyttämäsi lähdetiedostot repositoriosi doc-kansioon niin ne pysyvät tallessa muutosten varalta.
Seuraavaksi:
Suunniteltuasi ja dokumentoituasi tietokannan rakenteen varmista, että saat sen pystyyn palvelimelle.