Dokumentointi ja kuvailutiedot

Sisällysluettelo

Dokumentointi ja kuvailutiedot auttavat varmistamaan, että työskentelysi on sujuvaa ja järjestelmällistä sekä takaavat tutkimuksesi toistettavuuden ja luotettavuuden.

DOKUMENTOINTI

Tieteellisessä tutkimuksessa edellytetään, että koko tutkimusprosessi dokumentoidaan niin tarkasti, että tutkimusasetelma on mahdollista toistaa jälkikäteen samanlaisena. Näin tutkimustulosten paikkansapidettävyys voidaan todentaa. 

Vaade dokumentoinnista koskee myös tutkimusaineistoa, sillä se on olennainen osa tutkimusprosessiasi. Aineiston tuottaminen, rakenne, käsittely ja analyysi tulee siis pystyä kuvaamaan muille ymmärrettävässä muodossa ja niin tarkasti, että myös tämä prosessi olisi (ainakin periaatteessa) toistettavissa. 

  • Dokumentointi lisää tutkimustulostesi toistettavuutta, läpinäkyvyyttä ja luotettavuutta.
  • Dokumentoinnin avulla voidaan myös todentaa, että tutkimusaineisto on tuotettu ja sitä on käsitelty eettisesti, hyvän tieteellisen käytännön mukaisesti sekä lainsäädännön edellytysten mukaisesti.

Dokumentointi on olennainen osa aineistonhallintaa. 

  • Päätä aineistonhallintasuunnitelmassasi, kuinka aiot dokumentoida aineistonhallinnan ja -analyysin prosessin niin, että pystyt kuvaamaan sen tarkasti ja yksityiskohtaisesti opinnäytteessäsi.
  • Käytännössä siis pidät kirjaa siitä mitä teit, milloin, miten, miksi ja kenen kanssa.
  • Eri tieteenaloilla voi olla dokumentointiin liittyviä omia käytänteitä. Jos omalla alallasi ei ole käytössä jotain tiettyä käytännettä, voit hyödyntää esimerkiksi formaalia tutkimuspäiväkirjaa, laboratoriopäiväkirjaa, tekstidokumenttia tai excel-taulukkoa.
  • Valitset minkä käytänteen tahansa, niin päiväkirjasi / dokumenttisi tulee sisältää kattava kuvaus koko aineistonhallinnan prosessista ja elinkaaresta.

Dokumentointi hyödyttää myös sinua itseäsi. Esimerkiksi:

  • Kun kirjaat ylös haastatteluiden teemat, löydät jatkossa helpommin tekemiesi haastatteluiden joukosta juuri sen yhden haastattelun, jossa puhuttiin asiasta X.
  • Kun kirjaat ylös käyttämäsi muuttujat, niiden selitykset ja niihin tekemäsi muutokset - esimerkiksi, jos olet alunperin kysynyt taustamuuttujan "ikä" vuoden tarkkuudella, mutta haluatkin muokata muuttujaa niin, että ikä haarukoituu viiden vuoden tarkkuudella - niin muistat käsitellä niitä myöhemmin analyysissasi johdonmukaisesti.
  • Kun kirjaat ylös jokaisen vaiheen, jossa olet muokannut aineistoa, voit aina palata työstämään oikeaa aineistoversiota.

Työskentelystäsi tulee siis sujuvampaa, systemaattisempaa ja jäsentynempää. Tiedät aina mitä olet tekemässä, mitä aineistossassi on ja mitä kulloinkin tarvitset. Jos työskentelyysi tulee tauko, voit palata aineiston pariin ongelmitta. Ja jos teet opinnäytettäsi parin kanssa, osana tutkimusryhmää tai vaikkapa yritysyhteistyönä, on myös kumppaneidesi helppo ymmärtää mitä olet tehnyt ja mitä aiot tehdä. 

KUVAILUTIEDOT

Aineiston peruskuvailutietojen (= metatiedot / metadata)  kirjaaminen, täydentäminen ja päivittäminen on osa aineistonhallinnan dokumentointia.

  • Huolellinen kuvailu parantaa aineiston laatua ja on toistettavuuden kannalta olennaista!
  • Kuvailutiedot tekevät tutkimusaineistostasi ymmärrettävää ja käyttökelpoista.
  • Kuvittele aineistosi suljettuna pakettina, jonka sisältöä et tunne. Kuvailutiedot ovat ikään kuin paketin päällä oleva tarra, jossa kerrotaan paketin sisältö.
  • Metatieto on "tietoa tiedosta": tässä tapauksessa kuvailutietoa tutkimusaineistostasi.
     

Kuvailu on tärkeää erityisesti jos aineisto julkaistaan, mutta myös muulloin oman työn tueksi.

  • Jos tutkimusaineisto tai pelkät sen metatiedot julkaistaan, tarvitaan aineistoa kuvailevat perustiedot, jotka on laadittu mahdollisuuksien mukaan ihmis- ja koneluettavassa muodossa ja jotka mahdollistavat aineiston identifoimisen ja löydettävyyden.
  • Jos tavoitteenasi on aineiston tallentaminen, säilyttäminen, arkistointi tai julkaiseminen jatkokäyttöä varten, sinun on kiinnitettävä erityistä huomiota aineistosi kuvailutietojen kirjaamiseen.
  • Perustutkinto-opiskelijoiden opinnäytteen tutkimusaineistoa ei tavallisimmin kuitenkaan valmistella jatkokäyttöä varten, jolloin kuvailutiedot toimivat enemmänkin omana työkalunasi. 
     

Kuvailutiedot muodostavat aineiston sisällysluettelon, jonka avulla tiedostot ja kansiot pysyvät järjestyksessä. 

  • Kuvailutietojen avulla varmistat, että pystyt löytämään kaiken tarvittavan ja tulkitsemaan aineiston yksiselitteisesti käyttöhetkestä ja -kontekstista riippumatta.
  • Jos sinulla olisi pelkkä keräämäsi aineisto, mutta ei minkäänlaista selittävää tietoa ja gradun tekemiseen tulisi tauko, muistaisitko enää kuukauden päästä, mitä olit tekemässä ja mitä missäkin tiedostossa on?
  • Esimerkiksi: sinulla on kaksi kokoelmaa valokuvia, toinen kokoelma sinun ottamiasi kuvia ja toinen neljän tutkittavan ottamia kuvia.
    • Mitä perustietoja sinun on kirjattava, jotta erotat kokoelmat ja yksittäiset valokuvat toisistaan ja jotta pystyt sekä työskentelemään sujuvasti että dokumentoimaan työskentelyäsi?
    • Olet lisäksi tehnyt jokaisen tutkittavan kanssa sopimuksen, jolla he määräävät, kuinka saat käyttää heidän valokuviaan. Millaisia tietoja sinun on kirjattava, että löydät tarvittaessa oikeaa kuvaa koskevan oikean sopimuksen?
    • Entä jos olet vieläpä sopinut luovuttavasi aineiston tutkimusryhmän käyttöön. Millaisia tietoja sinun on aineistostasi kirjattava, jotta tutkimusryhmän jäsenet kykenevät ymmärtämään aineistosi?

Tutkimuksesi alkuvaiheessa et välttämättä pysty vielä aivan tarkasti määrittelemään kaikkia tutkimuksesi kannalta relevantteja kuvailutietoja, mutta suunnittele ne silti etukäteen sillä tarkkuudella kuin on mahdollista ja täydennä työn edetessä. 

Entä jos käytät valmiiksi koottua, arkistoitua tai julkaistua aineistoa? 

Valmiissa aineistossa arkistoija / julkaiseva taho on tehnyt aineiston kuvailun ja löydät metatiedot arkiston aineistoluetteloista tai aineiston lisätiedoista. 

  • Huomioi kuitenkin, että valmiin aineiston pohjalta tuottamasi aineiston osat, kuten esimerkiksi taulukoinnit, sinun on kuvailtava itse.
  • Omassa aineistossasi voit tallentaa sekä tutkimusaineiston että sen kuvailutiedot sisältävät tiedostot samaan paikkaan.

Aineiston kuvailutiedot yhdistettynä ainestonhallinnan prosessin dokumentointiin toimivat aineistosi luku- ja käytöoppaana.

TAVANOMAISIA KUVAILUTIETOJA

Yleisesti käytetty tapa aineiston kuvailutietojen kirjaamiseen on niin kutsuttu readme-tiedosto. Readme on tekstitiedosto, joka sisältää peruskuvailutiedot aineiston sisällöstä sekä yksityiskohtaiset ohjeet siitä, kuinka aineistoa tulee ymmärtää ja käsitellä. 

Metatietoja on monenlaisia ja eri tilanteissa saatetaan tarvita erilaisia metatietoja. 

Tässä listattuna tavanomaisimpia kuvailutietoja.

Yleiset kuvailutiedot

  • Koko aineiston nimi – sisältöä kuvaavasti
  • Tutkijan/tutkijoiden nimet
  • Mahdolliset muut tutkimusprosessiin osallistujat rooleineen, esimerkiksi litteroija
  • Milloin aineisto on kerätty (pp.kk.vvvv tai aikaväli)
  • Missä aineisto on kerätty, esimerkiksi ”näytteet on otettu paikassa x” jos olennainen tieto
  • Avainsanat, esimerkiksi sosiaalityöntekijät, eduskuntavaalit, verkkopalvelut
  • Miten dokumentoit aineiston keräämisen ja käsittelyn? Esimerkiksi formaali tutkimuspäiväkirja tai excel-taulukko.

Tiedostot ja kansiot

Millä logiikalla nimeät kansiot ja tiedostot (kansiorakenne, uusimman tiedoston tunnistaminen)?

  • Nimeä tiedostot ja kansiot johdonmukaisesti samalla tavalla – sisältöä kuvaavasti
    • Lyhyt kuvausteksti kansion sisällöstä (esimerkiksi .txt-tekstidokumentti, joka tallennetaan kansioon).
    • Tarvittaessa kuvausteksti siitä, miten tiedostot ja kansiot on nimetty (esimerkiksi .txt-tekstidokumentti, joka tallennetaan kansioon).
  • Luo johdonmukainen kansiorakenne ja kirjoita muistiin, missä aineisto on
    • Kansiopolku esimerkiksi U: Documents > Opiskelu > Gradu > Data.
    • Jos aineisto tai osa siitä on muualla kuin tietokoneella, kirjoita muistiin, missä aineisto on.
    • Jos aineisto on todella laaja, saatat tarvita hakemiston, joka helpottaa kulloinkin tarvittavan tiedon löytymistä aineistosta.
  • Milloin kansiot ja tiedostot on luotu (pp.kk.vvvv tai aikaväli).
  • Milloin eri versiot on luotu (pp.kk.vvvv tai aikaväli).
    • Kun teet merkittäviä muutoksia tai eri versioita, kuvaile muutokset esim. tiedoston nimessä / erillisessä tekstidokumentissa sekä myös tutkimuspäiväkirjassa.

Menetelmät

  • Kerro käyttämäsi menetelmät
    • Kuinka aineisto on kerätty?
    • Mitä laitteita tai ohjelmistoja on käytetty? Millaisilla asetuksilla? Kuinka esimerkiksi mittalaitteet on kalibroitu?
    • Kuinka aineistoa on käsitelty ja valmisteltu analysoitavaksi?
  • Varsinaiset tutkimus- ja aineiston analyysimenetelmät kuvataan yleensä opinnäytteen tutkimussuunnitelmassa, samoin perustellaan esimerkiksi otoksen valinta aineistosta.

Ohjeet aineiston hyödyntämiseen ja tulkitsemiseen

  • Kuinka aineistoa käytetään tutkimuksessasi?
  • Millaisia laitteita tai ohjelmistoja tarvitaan, jos keräämääsi dataa halutaan tarkastella?
    • Tarvitaanko lisäksi erilliset ohjeet, kuinka ohjelmistot asennetaan ja kuinka aineistoa voidaan niiden avulla käsitellä?
  • Muuttujat ja niiden määritelmät.
  • Koodien, symboleiden ja lyhenteiden selitykset.
  • Aineiston mahdollisten puuttuvien/puutteellisten kohtien merkitseminen

Aineiston jakamiseen ja pääsyyn liittyvät tiedot

  • Aineiston käyttöä määrittelevät lisenssit, esimerkiksi CC(Creative Commons)-lisenssit?
  • Aineiston käyttöä määrittelevät sopimukset tekijän-/lähioikeuksista?
  • Muut aineiston jakelua ja käyttöä rajoittavat tekijät (esimerkiksi henkilötiedot).
  • Onko aineisto jo julkaistu jossain? Miten siihen pääsee käsiksi?

MUISTILISTA

  • Suunnittele etukäteen:
    • Kuinka aiot organisoida työskentelyäsi?
    • Kuinka aiot dokumentoida aineistonhallinnan prosessin ja elinkaaren?
    • Mitä kuvailutietoja sinun on kirjattava, jotta aineistosi on ymmärrettävää ja käyttökelpoista?
  • Täydennä ja päivitä tietoja koko tutkimusprosessin ajan.
  • Onko aineistoa tarkoitus jatkokäyttää? Luovutatko sen esimerkiksi tutkimusryhmän käyttöön tai vaikkapa Tietoarkistolle?
    • Kiinnitä aineiston kuvailutietojen laatuun erityistä huomiota. Ei riitä, että vain sinä itse ymmärrät miten aineisto on tuotettu, miten sitä on käsitelty, miten sitä pitää tulkita ja millaisilla välineillä sitä voi hyödyntää myös jatkossa.
    • Ota selvää, mitä vaatimuksia kuvailutiedoille valitsemallasi julkaisu- tai arkistointipalvelulla on.

Osio liittyy kaikkiin FAIR-periaatteisiin eli Findable, Accessible, Interoperable ja Re-usable.