ohjelmistodokumentaation

Ohjelmistodokumentaatio on ohjelmistojärjestelmän toiminnan ja käytön tukemiseen tarkoitettujen asiakirjojen kokonaisuus. Se kattaa sekä käyttäjille että kehittäjille suunnatun materiaalin ja kuvaa järjestelmän tarkoituksen, vaatimukset, arkkitehtuurin, toteutuksen sekä käyttö-, asennus- ja ylläpitotoimenpiteet. Dokumentaatio voi olla sekä julkista että sisäistä, ja sen tarkoituksena on helpottaa ymmärrystä sekä rakennetta, vaihtoa ja käyttöä.

Päätyyppejä ovat muun muassa käyttäjädokumentaatio (käyttöohjeet, asennusohjeet, ohjeistukset), tekninen dokumentaatio (vaatimukset, arkkitehtuuri, rajapinnat, tietoturva), kehitysdokumentaatio (koodikommentit, arkkitehtuurimallit), testidokumentaatio (testisuunnitelmat, testiraportit) sekä tuotearkisto (release notes, versionointi). Hyödyllistä on erottaa toimitettavien tuotteiden ja kehitysprosessin sisäisten dokumenttien välillä.

Dokumentaation tavoitteena on parantaa ohjelmiston käytettävyyttä, lähdekoodin ylläpidettävyyttä sekä muutostiedon hallintaa, varmistaa laatu ja helpottaa säädösten sekä standardien noudattamista. Elävä dokumentaatio pyritään pitämään ajan tasalla koko elinkaaren ajan, ei vain tuotteen julkaisun yhteydessä.

Hallinta ja parhaita käytäntöjä ovat dokumentaation integrointi osaksi kehitysprosessia, versionointi ja archivointi, yhtenäiset kirjoitus- ja viitemenetelmät sekä automatisointi API- ja koodidokumentaation osalta. Haasteina ovat erityisesti ajantasaisuuden ylläpitäminen, laadunvarmistus, monikielisyyden hallinta sekä dokumentaation laajuuden ja käytön tasapainottaminen.