dokumentointi

Dokumentti on mahdollisimman tarkka kuvaus työprojektista. Dokumentti sisältää tekstiä ja kuvia, sekä luettelon mahdollisista käytettävistä ohjelmista. Dokumentin tarkoitus on helpottaa työn suoritusta ja samalla saadaan kirjallista tietoa miten työ on tehty ja muut voivat suorittaa työtehtävän dokumentin perusteella.

lyhyt työselostus sisältää kansilehden, tehtävän kuvauksen ja analysoinni,ratkaisuperiaatteen,ohjen ja sen osien kuvaauksen,testausjärjestelun ja tarvittavat liitteet.

Kattava työnselostus on laajenpi, se sisältää myös sisällysluettelon,kirjallisuusviitteet jos on, käyttöohjeet ja mahdollisen työpäiväkirjan. Seuraavaksi käymme läpi dokumentin osat.

Kansilehti - Tähän kirjataan kurssi johon työ liittyy, työn aihe, ohjaaja, koulutusohjelma,opiskelijanumerot sekä sähköpostiosoitteet.

sisällysluettelo - kappaleiden otsikot,sivunumerot sekä mahdollinen liiteluettelo

tehtävän kuvaus ja analysointi - sisältää selostuksen annetusta tehtävästä, muut tehtävään liittyvät seikat kuten alkuperäiseen tehtävään tehdyt tarkennukset ja muutokset sekä pohdintaa tehtävään liittyvistä mahdollisista laajennuksista.

Ratkaisuperiaate - esittelee yhteenvedon ratkaisun kulmakivistä ja selostaa käsitteistöä. Tähän kirjataan käytetyt kaavat ja ratkaisuperiaate. Sanallinen selostus tulee pitää mahdollisimman selkeänä ja välttää turhia yksityiskohtia.

ohjelman ja osien kuvaus - Kuvataan käytetyt ohjelmat ja niiden toimintaperiaate, lukijan on mahdollista saada tietoa käytetystä ohjelmasta ja kuinka ohjelmaa on käytetty tehtävän ratkaisussa.

testausjärjestely - tarkoitus on testata että ohjelma toimii oikein. Testauksessa tehdyt havainnot kirjataan ylös.

liitteet - käytetyt lähteet. Sähköisessä muodossa olevat liitteet palautetaan esim. zip-tiedostona. Liitteisiin myös lisätään ohjelmalistaus ja ohjelman käyttöohje jotta ohjaajan on mahdollista testata ohjelmiston toiminta.