Projekti: dokumentaatio¶

Projekti kuuluu dokumentoidan osana tehtyä työtä. Projektin dokumentaatiossa kohderyhmänä on tiimi itse sekä työn arvosteleva kurssihenkilökunta. Jokaisessa harjoitustyössä on siis oltava versionhallinnassa hakemisto Documentation, jossa ajantasainen dokumentaatio ohjelmasta sijaitsee. Projektin arvosteltava dokumentaatio kokonaisuudessaan sisältää:

PDF-dokumentti Documentation -hakemistossa
Versionhallinnan lokit
Koodin kommentit, ml. mahdollinen omien luokkien rajapintadokumentaatiot

Kaksi jälkimmäistä on mukana versionhallinnassa itsenään eikä niitä liitetän PDF-dokumenttiin.

PDF-dokumentissa kuvataan:

ryhmän toteuttaman ohjelman rakenne. Selkeä paperille käsin piirretty kaavio käy oikein hyvin.
tärkeimpien luokkien vastuujako
ohjelman toiminta ml. jokainen vapaaehtoinen ominaisuus selkeästi kuvattuna
ne ryhmän toteuttamat luokat, joissa on dokumentoituna esi- ja jälkiehtoja yms.
sovittu ja toteutunut työnjako
lyhyt käyttöohje
tiedossa olevat ongelmat tai puutteet

Dokumentin saa kirjoittaa itselle mieluisalla tavalla, mutta se tulee palauttaa PDF:nä. PDF-dokumentin tulee olla enintään viisi (5) sivua pitkä.