Advanced Kittenry - Tietokantasovellusohjeet

Perusasioiden dokumentointi

Avaa mieleisesi tekstinkäsittelyohjelma ja tutustu dokumentaatio-ohjeen avulla miten tuotetaan dokumentaation kaksi ensimmäistä lukua Johdanto, Yleiskuva järjestelmästä

Kirjoita johdantoon kuvaus valitsemastasi aiheesta ja ohjelmointikielestä, sekä mahdollisista muista tekniikoista ja kirjastoista mitä aiot käyttää työssäsi.

Mieti sen jälkeen mitä käyttötapauksia työssäsi voisi olla. Aihekuvauksissa annetut toimintolistat ovat hyvä lähtökohta, joskaan nämä listat eivät ole täydellisiä. Nimeä eri sidosryhmät ja piirrä näistä kaikista kaavio. Tiedostolla on tässä vaiheessa pituutta noin muutama sivu plus mahdolliset kansilehdet ja sisällysluettelot.

Lopuksi tallenna dokumentaatiostasi pdf-versio repositorioosi kansioon doc nimellä dokumentaatio.pdf. Voit sijoittaa doc-kansioon kaikki tarvitsemasi dokumentaatioon liittyvät tiedostot kunhan pidät huolen siitä, että siellä on tietokantasovelluksen päädokumentti nimellä dokumentaatio.pdf. Tuo PDF-tiedosto on se, jonka ohjaajasi lukee, mutta on hyvä pitää lähdetiedostotkin versionhallinnassa.

Seuraavaksi:

Kun olet valinnut aiheen ja haluamasi toteutustekniikat pystytä itsellesi palvelin ja tietokanta.