previous next Up Title Contents Index

Dokumentointi

Dokumentointi (documentation) on keskeisin osa ohjelmistotyötä.

Valmis ja testattu ohjelma on dokumentoitava tulevia käyttäjiä ja ylläpitäjiä varten:

    Kaikki ratkaisumenetelmät kirjataan.
    Kirjoitetaan ohjelman käyttöohje.
    Myös testaus on kuvattava.

Testauksen kuvauksen perusteella ohjelma on kyettävä milloin tahansa testaamaan uudelleen. Jotta testaus ei olisi liian hankalaa, testausvaiheessa pitää valmistaa riittävästi uudelleenkäytettävissä olevaa testaustyökalustoa ja -materiaalia.

Dokumentointivaiheessa tuotetaan vielä ylläpito-ohje, jossa kuvataan, miten ohjelmaan voidaan lisätä uusia piirteitä ja mitä asioita on otettava huomioon muutoksia tehtäessä.

Käytännön ohjelmointityössä kukin ohjelmoinnin työvaihe (määrittely, suunnittelu jne.) tuottaa joukon dokumentteja. Toteutusvaiheessa syntyvä ohjelma on itse asiassa vain yksi dokumentti muiden joukossa. Se on kaikista laadituista dokumenteista yksityiskohtaisin ja tarkin. Se sisältää täsmälliset ohjeet siitä, miten määrittelyvaiheessa asetetut tavoitteet saavutetaan ohjelmallisesti.

Vuokaaviot

previous next Up Title Contents Index