Mitä jokaisen tutkijan tulee tietää dokumentoinnista – uusi opas tiivistää perusasiat kahteentoista sivuun

Helsingin yliopiston Datatuen julkaisema opas kokoaa yhteen dokumentoinnin perusasiat. Kompakti yleisopas vastaa useimpien tutkijoiden dokumentointitarpeisiin. 
 
Miten tutkimusdatan dokumentoinnissa voisi päästä alkuun? Mistä löytyisivät selkeät ja tiiviit ohjeet dokumentointiin?
 
Helsingin yliopistossa syksyn aikana kirjoitettu dokumentoinnin opas Making a research project understandable – Guide for data documentation on vastaus tutkijoiden esittämiin kysymyksiin. Kompakti opas kokoaa kahteentoista sivuun dokumentoinnin perusteet. Oppaan ovat toteuttaneet tietoasiantuntijat Siiri Fuchs ja Mari Elisa Kuusniemi Helsingin yliopiston datatuesta.
 
”Vastaavaa dokumentoinnin opasta ei ole ollut. Aiheesta kyllä löytyy paljonkin tietoa, mutta monet oppaat käsittelevät vain hajanaisesti dokumentoinnin eri osa-alueita. Tutkijoiden aineistonhallintasuunnitelmista (data management plan, DMP) on huomannut, että harva ymmärtää, mitä dokumentointi tarkoittaa”, Fuchs sanoo.
 
”Tässä oppaassa ovat perusteet, joista voi lähteä syventämään. Useimmille pitäisi kuitenkin riittää tässä oppaassa esitetty dokumentoinnin taso. Data scientistit ja data managerit ovat sitten asia erikseen”, Kuusniemi toteaa.
 
Dokumentointi on tutkijan perustaito
 
Dokumentointiopas on tarkoitettu kaikille, jotka tekevät tutkimusta. Tutkimusaineiston dokumentointi on tutkijan perustaito, josta on hyötyä sekä tutkimuksen aikana että sen jälkeen – oppaassa nämä molemmat vaiheet on pyritty ottamaan huomioon.
 
”Opas on tarkoitettu tutkimuksen laadusta kiinnostuneille ja tutkimuksen prosesseihin tehoa etsiville – sekä niille, jotka haluavat aidosti avata aineistonsa. Opas on tarkoitettu kaikille niille, jotka haluavat implementoida FAIR-periaatteet omaan organisaatioonsa. Tässä on nyt FAIR-periaatteet esitelty”, Kuusniemi toteaa.
 
FAIR-periaatteisiin on kirjattu, mitä tutkimusaineistojen aito avaaminen käytännössä tarkoittaa: se tarkoittaa löydettävyyttä (findable), saavutettavuutta (accessible), yhteentoimivuutta (interoperable) ja uudelleenkäytettävyyttä (reusable).
 
Opasta voi hyödyntää monella tavalla
 
On selvää, että dokumentoinnin perusteiden tiivistäminen kahteentoista sivuun on vaatinut rajaamista. Esimerkiksi tiedostoformaatit nähtiin enemmän tallennukseen liittyvänä asiana. Vaikka kaikkea ei selitetä juurta jaksain, opas voi ohjata tutkijaa eteenpäin.
 
”Idea on, että oppaassa esitetään lyhyesti, ytimekkäästi ja esimerkein, mitä jokin asia tarkoittaa. Jos haluaa tietää enemmän, oppaan avulla on helppo lähteä etsimään muita tiedonlähteitä”, Fuchs kertoo.
 
Osalle tutkijoista oppaassa esitetyt asiat voivat tuntua itsestäänselviltä. Oppaan sivulle 4 koottu tiivistelmä dokumentoinnin peruspalasista voi toimia kuitenkin hyödyllisenä tarkistuslistana tutkimusprojektissa.
 
”Siitä voi tarkistaa, mitä tutkimuksen dokumentoinnista puuttuu. Ja jos tutkimukseen kuuluu useita henkilöitä, tämän avulla kaikki voivat päästä kartalle tietyistä dokumentointiin liittyvistä perusasioista. Tämä toimii myös uusien ihmisten perehdyttämisen välineenä”, Kuusniemi sanoo.
 
Tiivis yleisopas ei voi vastata yksityiskohtaisesti tieteenalojen erityiskysymyksiin. Mikään ei kuitenkaan estä kehittelemästä perusoppaan päälle tieteenalaspesifimpää opasta. Fuchsin mukaan opas soveltuu myös opetuksen välineeksi.
 
”Opas tarjoaa helpon pohjan koulutukseen, ja olisi hienoa, jos dokumentoinnin perusteet tulisivat mukaan yliopiston peruskoulutukseen”, Fuchs sanoo.
 
Dokumentoinnin opasta on tarkoitus päivittää käyttäjien palautteen perusteella.
 
Palautetta oppaasta:
 

Kolme tärkeintä pointtia dokumentoinnista

1. Hyvä dokumentoinnin suunnittelu vie aikaa dokumentoinnin alussa, mutta säästää aikaa, rahaa ja hermoja lopussa. Lopulta, dokumentointi ei ole niin iso homma. Dokumentointi helpottaa tulevaisuuden minän elämää, ja se säästää myös muiden aikaa.
 
2. Tutkimusaineiston dokumentaatio kuuluu tutkijan perustaitoihin. Sitä tarvitaan aina, ja se kuuluu hallita. On erikoista, että sitä on opetettu ja tuettu näin vähän siihen nähden, miten olennainen osa se on tutkimuksen luotettavuutta (virheiden mahdollisuus pienempi), toistettavuutta (tulosten verifioitavuus) ja vaikuttavuutta.
 
3. Datan dokumentointi ei ole erityisen vaikeaa. Siihen pitää kiinnittää kuitenkin huomiota, jotta se olisi alusta loppuun laadukasta. Useimmat ovat tehneet dokumentointia osittain, mutta sieltä saattaa puuttua palasia. Kannattaa kiinnittää huomiota näihin puuttuviin osiin – dokumentoinnin opas auttaa niiden tunnistamisessa.