Dokumentaatioissa

Dokumentaatioissa on suomen kielen inessiivinen monikko muoto dokumentaatioista, dokumentaatioissa. Se viittaa dokumentaation sisällöön tai siihen kokonaisuuteen, joka koostuu dokumenteista, ohjeista, spesifikaatioista ja vastaavista aineistoista. Käytössä termi kertoo usein, missä tieto on säilytetty tai missä sitä tarkastellaan, esimerkiksi “dokumentaatioissa on ohjeet” tai “dokumentaatioissa on tilastotietoja”.

Sanan taustalla on erottelu dokumentaation ja dokumentoinnin välillä: dokumentaatio tarkoittaa itse materiaalien kokonaisuutta, kun taas dokumentointi viittaa toimintaan, jossa tietoa kerätään ja tallennetaan. Dokumentaatioissa viitataan yleisesti ammatillisissa ja teknisissä yhteyksissä siihen, mitä on dokumentoitu ja miten se on järjestetty.

Tyypillisiä konteksteja ovat ohjelmistokehitys, tuotannonhallinta, tutkimus ja arkistointi. Dokumentaatioissa voidaan yhdistää manuaalit, ohjeet, käyttöliittymäkuvaukset, prosessikuvaukset, vaatimukset sekä muuttuvien versioiden historiat. Hyvä dokumentaatio on selkeää, johdonmukaista, ajantasaista ja helposti löydettävissä; siihen kuuluu usein versionhallinta, tekijätiedot ja viitteet.

Käytännön huomioita: määritelmä, tavoite ja kohdeyleisö tulisi ilmetä dokumentaatioissa, jotta lukija löytää tarvitsemansa tiedon helposti. Selkeä rakenne, termien johdonmukaisuus ja kattava hakutuki parantavat käytettävyyttä. Dokumentaatioissa korostuvat laatu- ja hallintavaatimukset sekä lainopillisten ja standardien noudattaminen.

Lisäksi suhteessa muihin termiin: dokumentaatio ja dokumentointi eroavat toisistaan sekä sisällöltään että tarkoitukseltaan; doku mentaa on sekä lopullista materiaalia että systemaattisen keruun kohde.