dokumentointi

Dokumentointi on prosessi, jossa organisaatio kerää, tallentaa, järjestää ja julkaisee informaatiota tarkoitettuja käyttäjiä varten. Dokumentointi voi kattaa tuotteen tai palvelun käyttöohjeet, tekniset määrittelyt, suunnitelmat, testiraportit sekä ylläpito- ja koulutusmateriaalit. Sen tavoitteena on varmistaa tiedon saavutettavuus, ymmärrettävyys, oikeellisuus ja yhteiskäyttö eri sidosryhmien kesken sekä tuki käyttöönoton, ylläpidon ja laadunhallinnan prosesseja.

Dokumentointi jaetaan tyypillisesti käyttäjä-, kehittäjä- ja ylläpitodokumentaatioon. Käyttöohjeet suunnataan loppukäyttäjille; tekninen dokumentaatio ohjelmistokehittäjille, järjestelmätoimittajille sekä tukitiimeille; API- ja kehittäjätiedot mahdollistavat integraatiot. Kohderyhmä riippuu tiedon tarkoituksesta ja sisältöstä sekä lukijan teknisestä taustasta.

Dokumentointiprosessi sisältää suunnittelun, sisällön määrittelyn, kirjoittamisen, tarkastuksen, julkaisemisen sekä ylläpidon. Hyvin hallittu prosessi hyödyntää versiointia, sisällön uudelleenkäyttöä sekä muutosten seurantaa ja laadunvalvontaa.

Laatukriteerit: selkeys, tarkkuus, kattavuus, johdonmukaisuus, saavutettavuus sekä kieliopin ja teknisen terminologian johdonmukaisuus. Dokumentaation tulee olla helposti päivitettyä ja versionhallinnalla hallittua. Kansainväliset ja organisaatiokohtaiset standardit ohjaavat laatua ja yhteensopivuutta.

Ohjelmisto- ja teknisissä ympäristöissä dokumentointi hyödyntää kirjoitus- ja merkkauskielet (esim. Markdown), sisällönhallintajärjestelmiä, wikejä ja versionhallintaa. Avainroolit ovat tekniset kirjoittajat, alansa asiantuntijat, toimittajat, testaus- ja laadunvarmistustiimit sekä projektinhallinta. Haasteisiin kuuluu ajantasaisuuden ylläpitäminen, monikielinen lokalisaatio ja saavutettavuusvaatimusten noudattaminen.