Aineistojen laatu ja dokumentointi

Aineistojen uudelleenkäytön edellytys on riittävä dokumentointi. Ensimmäinen ehot on tietenkin se, että aineistot ovat edes löydettävissä. Tästä voit lukea enemmän Avoimen tieteen käsikirjasta kohdista Datan avaaminen ja Metatiedot.  Aineistojen käytettävyydellä on kuitenkin myös muita vaatimuksia dokumentoinnin suhteen.

Tutkimusprosessin dokumentointi

Kun tutkimusta tehdään suuri osa dokumentoinnista on jo olemassa eri paikoissa: tietojärjestelmissä, tiedostoissa, lokitiedoissa, menetelmien kuvauksissa jne. Osa voi olla vain tutkijan omassa päässä, varsinkin jos kyseessä on pienimuotoisempi tai kvalitatiivinen aineisto. Silloin on syytä varata aikaa menetelmien kuvailemiseen ja kirjaamiseen. On aina syytä huolehtia, että sähköisten aineistojen yhteydessä on saatavilla riittävästi tätä tietoa, jotta aineistoja voi käyttää uudestaan ja tutkimus toisintaa.

Menetelmiä ovat niin tutkimusprosessiin kuuluva toiminta. kuin käytettävät laitteet, ohjelmistot, kyselyt ja muut koodinpätkät. Näitä kaikkia on hyvä kuvata ja tutkimustyön aikana, sillä yksityiskohtia saattaa olla yllättävän vaikea muistaa jälkikäteen. Riittävä dokumentointi takaa myös sen, että esimerkiksi projektiin tulevat uudet kollegat saavat riittävät tiedot toimintatavoista. Hyvä dokumentointi on aina hyvän tutkimuksen edellytys.

Kannattaa siis tarkasti kirjata muistiin:

  • käytetyt instrumentit ja laitteet
  • niiden kalibrointi ja eri muuttujien arvot
  • käytetyt koodit ja ohjelmistot
  • miten aineisto on kerätty
  • miten sitä on käsitellty, kuka ja milloin
  • muut prosessit
  • eri versioiden hallinta
  • laadunvarmistusprosessit
Tieteenalasta riippuen tähän on erilaisia käytäntöjä, joita kannattaa seurata. Datan yhteyteen kannattaa luoda readme.txt-tiedosto, jossa kokonaisuus ja dokumentointi on kuvailtu. Koodia voi tallentaa esimerkiksi sopivaan tietoarkistoon tai GitHubiin, jonne voi Zenondo-palvelun kautta saada DOI-tunnisteen. Dokumentointi voi olla työlästä, mutta sitä tuskin koskaan on liikaa. Sen sijaan liian niukka dokumentaatio voi estää uudelleenkäyttöä.