Siirry sisältöön

LogoHelsingin yliopisto

Think Open

Digitaalisista tutkimuspalveluista ja avoimesta tieteestä / About digital research services and open science

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

Julkaistu 2018-12-102022-02-08 kirjoittanut Juuso P Ala-Kyyny

Helsingin yliopiston Datatuen julkaisema opas kokoaa yhteen dokumentoinnin perusasiat. Kompakti yleisopas vastaa useimpien tutkijoiden dokumentointitarpeisiin.

(This article is also available in English.)

Miten tutkimusdatan dokumentoinnissa voisi päästä alkuun? Mistä löytyisivät selkeät ja tiiviit ohjeet dokumentointiin?

Dokumentointioppaan ensimmäiset versiot julkaistiin marras–joulukuun taitteessa.

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 12 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

Kolme pointtia dokumentoinnista
    1. Hyvä dokumentoinnin suunnittelu vie aikaa dokumentoinnin alussa, mutta säästää aikaa, rahaa ja hermoja lopussa.
    2. Tutkimusaineiston dokumentaatio kuuluu tutkijan perustaitoihin. Sitä tarvitaan aina, ja se kuuluu hallita. Se on olennainen osa 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.

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 otettu 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 12 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.

Oppaasta löytyy dokumentoinnin tarkistuslista.

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 voi lähettää osoitteeseen datasupport@helsinki.fi.

Tämä haastattelu julkaistiin alun perin Avoin tiede -sivustolla.

KategoriatAvoin data / Open Data, Avoin tiede / Open Science, Tutkimusdatanhallinta / Research Data Management (RDM), Tutkimuspalvelut / Research Services Avainsanataineistonhallintasuunnitelma, datan dokumentointi, Datatuki, DMP, dokumentointi, FAIR, FAIR-periaatteet, metadata, metadataformaatit, oppaat

Think Open Blog

Tietoa blogista / About this blog >>

Toimitusneuvosto / Editorial Board >>

Kirjoittajaohjeet / Instructions for writers >>

Aiheet / Topics

  • Avoin data / Open Data (109)
  • Avoin julkaiseminen / Open Access (161)
  • Avoin opetus / Open Education (26)
  • Avoin tiede / Open Science (291)
  • Digihumanismi / Digital humanities (19)
  • Kansalaistiede / Citizen Science (4)
  • Tietosuoja / Data Protection (31)
  • Tietoturva / Information Security (23)
  • Tutkimuksen näkyvyys / Visibility of Research (63)
  • Tutkimuksen työkalut / Research Tools (63)
  • Tutkimusdatanhallinta / Research Data Management (RDM) (115)
  • Tutkimusinfrastruktuurit / Research Infrastructures (73)
  • Tutkimuspalvelut / Research Services (221)
  • Tutkimustunnisteet / Research Identifiers (18)

Kaikki blogitekstit julkaistaan CC-BY 4.0 -lisenssillä. Lisenssi ei koske kuvia. / All the blog texts are licensed under a CC-BY 4.0 license. The license does not apply to images.

Asiasanat / Tags

  • aineistonhallintasuunnitelma (21)
  • APC (38)
  • avoimet oppimateriaalit (18)
  • avoin data (32)
  • avoin julkaiseminen (92)
  • avoin opetus (24)
  • avoin tiede (111)
  • cOAlition S (22)
  • data (43)
  • Data Cleaning Week (23)
  • datan avaaminen (23)
  • datanhallinta (57)
  • datan säilyttäminen (18)
  • Datasiivousviikko (21)
  • Data Support (41)
  • Datasupport (51)
  • Datatuki (47)
  • DMP (32)
  • Elsevier (21)
  • EU (24)
  • FAIR (30)
  • gold OA (30)
  • green OA (45)
  • HELDA (44)
  • Helda Open Books (26)
  • hybrid OA (22)
  • julkaisuarkistot (39)
  • kirjoittajamaksut (28)
  • metadata (27)
  • open access (138)
  • open data (19)
  • open science (56)
  • plan S (34)
  • RDM (58)
  • repositories (23)
  • research data (25)
  • research data management (50)
  • rinnakkaisjulkaiseminen (22)
  • rinnakkaistallennus (33)
  • self-archiving (20)
  • Suomen Akatemia (31)
  • tiedekustantajat (21)
  • tutkimusdata (32)
  • tutkimusdatanhallinta (43)
  • yliopisto-opetus (18)

Arkisto / Archives

  • toukokuu 2022 (6)
  • huhtikuu 2022 (4)
  • maaliskuu 2022 (10)
  • helmikuu 2022 (9)
  • tammikuu 2022 (2)
  • joulukuu 2021 (6)
  • marraskuu 2021 (10)
  • lokakuu 2021 (9)
  • syyskuu 2021 (4)
  • elokuu 2021 (3)
  • kesäkuu 2021 (1)
  • toukokuu 2021 (5)
  • huhtikuu 2021 (8)
  • maaliskuu 2021 (11)
  • helmikuu 2021 (8)
  • tammikuu 2021 (6)
  • joulukuu 2020 (4)
  • marraskuu 2020 (7)
  • lokakuu 2020 (12)
  • syyskuu 2020 (12)
  • elokuu 2020 (7)
  • kesäkuu 2020 (6)
  • toukokuu 2020 (10)
  • huhtikuu 2020 (5)
  • maaliskuu 2020 (7)
  • helmikuu 2020 (4)
  • tammikuu 2020 (6)
  • joulukuu 2019 (27)
  • marraskuu 2019 (9)
  • lokakuu 2019 (16)
  • syyskuu 2019 (9)
  • elokuu 2019 (8)
  • kesäkuu 2019 (3)
  • toukokuu 2019 (8)
  • huhtikuu 2019 (5)
  • maaliskuu 2019 (6)
  • helmikuu 2019 (4)
  • tammikuu 2019 (7)
  • joulukuu 2018 (5)
  • marraskuu 2018 (4)
  • lokakuu 2018 (9)
  • syyskuu 2018 (7)
  • elokuu 2018 (6)
  • heinäkuu 2018 (3)
  • kesäkuu 2018 (5)
  • toukokuu 2018 (5)

Meta

  • Kirjaudu sisään
  • Sisältösyöte
  • Kommenttisyöte
  • WordPress.org

Think Open blog

Tietoa blogista /
About this blog

Toimitusneuvoston jäsenet /
Members of the editorial board

Kirjoittajaohjeet /
Instructions for writers

Palvelun tarjoaa WordPress