Dokumentointi

Teknologia-alalla on aina vallinnut taistelu siitä, miten toteutettavat järjestelmät pitäisi dokumentoida. Olemme halunneet vastata tähän ongelmaan vahvasti asiakkaan tarpeesta lähtevällä ja lisäksi elävällä dokumentaatiolla. Kun asiakkaan tarpeet kuvataan käsitetasolla ja sähköisesti jo ennen järjestelmän toteutuksen aloittamista, niin tämä toimii koko toteutuksen ajan karttana kehittäjille.

Olemme halunneet mahdollistaa projektiryhmälle, asiakas mukaan lukien, joustavan tavan kommunikoida ja jakaa mielipiteitä myös dokumentaation osalta. Näiden vaatimusten täyttämiseksi sovellamme Wiki-tyyppistä dokumentointitapaa. Tämä tarkoittaa, että käytännössä koko projektiorganisaatiolla on mahdollisuus muokata ja ylläpitää olemassa olevaa dokumentaatiota. Olemme todenneet, että määrittelyiden ja vaatimusten muuttuessa on tärkeää, että dokumentaatio voi elää vapaasti ja siten pysyä mukana muutoksissa.

Vaikka tällainen tapa dokumentoida saattaa kuulostaa sekavalta ja järjestäytymättömältä, niin kokemus on osoittanut, että yhdessä sovitut periaatteet mahdollistavat dokumentaation pysymisen yhtenäisenä ja selkeänä kuvausten kasvusta huolimatta.

Järjestelmän tekninen dokumentaatio tehdään yksikkötestien ja koodidokumentaation (JavaDoc, RDoc) avulla. Tällöin ohjelmistokehityksessä vahvistetaan toteutettavien moduulien suunnittelua ulkoisesti helppokäyttöisiksi. Lisäksi keskitytään järjestelmän todellisiin tarpeisiin pelkän koodin tuottamisen sijaan. Hyvin nimetyt testit, yksinkertainen, selkeä ja järjestelmäarkkitehtuuria seuraava koodi kertoo itsessään ohjelmiston toiminnasta.