Skip to Main Content

Opas hankkeiden aineistonhallintaan

Mitä datan dokumentoinnilla tarkoitetaan?

Aineiston dokumentoinnilla tarkoitetaan tutkimusaineiston kuvailua, eli sen avaamista, mitä aineistot ovat, miten ne ovat syntyneet ja miten niitä voidaan käyttää. Kuvailevaa tietoa kutsutaan metatiedoksi tai metadataksi.

Ilman dokumentointia aineisto on vain merkityksetön kokoelma yksittäisiä tiedostoja, numeroita ja merkkejä ja sitä voi olla mahdotonta ottaa käyttöön. Tutkimusaineiston sisällön, keruun ja muuttujien huolellinen kuvailu on edellytys aineiston käyttökelpoisuuden säilymiselle.

Projektipäällikkö tai tutkimuksesta vastaava henkilö huolehtii siitä, että hankkeessa kerätyn aineiston kuvailutieto tulee tallennetuksi asianmukaisella tavalla.

Miksi dokumentoida aineisto? 

  • Ymmärrät itse vielä viikkoja ja kuukausia myöhemmin, mistä aineistossa on kyse. Pystyt inventoimaan ja arvioimaan sitä.
  • Aineistosta tulee itsenäisesti ymmärrettävää ja siten uudelleenkäytettävää.
  • Tulokset ovat toistettavia aina raakadatasta lähtien. 
  • Aineistoasi ei käytetä tai tulkita aineistoasi tahattomasti väärin.
  • Toteutat hyvää tieteellistä käytäntöä ja varmistat, että aineistosi on mahdollisimman FAIR. 

Tutkimusaineiston metadata. Kuva: Tampereen yliopiston kirjasto: Tutkimusaineistojen hallinta. CC BY 4.0

Tutkimusaineiston metadata. Kuva: Tampereen yliopiston kirjasto: Tutkimusaineistojen hallinta. CC BY 4.0

Miten dokumentointi tehdään?

Dokumentoi data niin, että se on käyttöönotettävissä pitkänkin ajan päästä. Huomaathan, että itse datan lisäksi tarvitaan aineiston luomisen yhteydessä syntynyt materiaali.

 

Tallenna aineiston kanssa samaan hakemistoon teksti- tai pdf-tiedostoina:

  1. datan dokumentointi esimerkiksi readme-tiedostona
  2. aineiston kerääjille ja käsittelijöille annetut ohjeet ja muut dokumentit
  3. kirjoituspyynnöt, saatekirjeet
  4. haastattelukysymykset, kyselylomakkeet, haastattelurungot.

 

Tallenna datan dokumentointi esimerkiksi tekstitiedostona (txt) aineiston yhteyteen. Suosittelemme Readme-tiedoston tekoa.

Aineiston dokumentointiin on useita tapoja:

  • Readme-tiedostot - erillinen tekstitiedosto, jonne kuvailu kirjoitetaan ja joka tallennetaan aineiston yhteyteen. Readme-tiedostoja voi olla myös useita eri kansioissa, jolloin ne toimivat kansion sisällysluettelona.
  • Datatiedoston sisälle - esimerkiksi haastattelun alkuun haastateltavan taustatiedot tai Excel-taulukon yhdelle välilehdelle muuttujien kuvaukset ja käytetyt koodit ja lyhenteet.
  • Tietokanta- ja aineistonhallintaohjelmistot: hyödynnä valmiita ohjelmistoja, jotka usein tuottavat metadataa myös automaattisesti.
  • Sanastot: laadi sanasto, jossa selitetään esim. käytetyt muuttujat, termit ja lyhenteet.
  • Excel-taulukot ja tietokannat - toimivat usein tekstitiedostoa paremmin isoille aineistoille
  • Sovellukset, joita käytetään kuvailutiedon tallentamiseen
  • Tutkimuspäiväkirjat, digitaaliset tutkimuspäiväkirjat

Aineiston dokumentoinnilla kuvaat sekä itsellesi että muille, mistä aineistossa on kyse. Suunnittele aineiston dokumentointi mahdollisimman tarkkaan ja aloita se heti tutkimusprojektin alussa. Huolellisesti suunniteltu ja toteutettu dokumentointi helpottaa tutkimustyötä ja sitä on hankalaa, ellei mahdotonta, toteuttaa jälkikäteen.

Readme -tiedosto datan yhteyteen

Jos data säilytetään hankkeen päättymisen jälkeen, se avataan tai sitä jatkokäytetään, datan yhteteen tulee tehdä tiedosto, jossa kuvataan datan sisältö ja muuttujat sekä tarjotaan ohjeet datan käyttöönottoon. Tämä voidaan tehdä yksinkertaisena tekstitiedostona. Tätä tiedostoa kysytään yleensä README-tiedostoksi.

Ohjeita ja pohjia README-tiedoston tekoon:

Seuraavassa on joitakin yleisiä ohjeita niistä asioista, joita projektista ja aineistosta tulisi kuvailla tieteenalasta riippumatta.

Nämä tiedot tulee liittää readme.txt-tiedostoon tai vastaavaan aineistojen yhteyteen.

  • TITLE: Aineiston tai sen tuottaneen projektin nimi
  • CREATOR: Aineiston luoneet henkilöt tai organisaatiot osoitetietoineen
  • DESCRIPTION Aineiston ja kansiorakenteen yleiskuvaus
  • LOCATION: Kun aineisto liittyy fyysiseen paikkaan, kirjaa sen alueellinen kattavuus
  • METHODOLOGY: Kuvaile, miten aineisto on koottu tai luotu, mukaan lukien käytetty välineistö ja ohjelmistot, koeohjelmat, haastattelurungot ym. seikat, joita kuvailisit myös tutkimuksenaikaisiin muistiinpanoihin
  • INFORMATION ABOUT DATA FILES
    • IDENTIFIER: Aineiston identifiointinumero, vaikka se olisi vain organisaation sisäinen projektitunnus
    • LOCATION: Mistä aineiston voi löytää
    • DATES: Keskeiset aineistoon liittyvät päivämäärät, ml. projektin alku- ja loppupäivät, aineiston muokkaus- ja valmistumispäivät sekä ajanjakso, jota aineisto kattaa
    • SUBJECT: Avainsanat tai ilmaukset, joilla aineiston aihetta tai sisältöä kuvataan
    • FILE FORMATS: Mitä tiedostoformaatteja on käytetty
  • FUNDERS: Tutkimuksen rahoittajat
  • RIGHTS: Aineistoon liittyvät immateriaalioikeudet
  • LANGUAGE: Aineiston sisällön kieli (kielet), jos sellaisia on.

Tiedostojen ja kansioiden nimeäminen

Suunnittele tiedostojen ja kansioiden nimeämiskäytäntö heti projektin alussa. Luo yhtenäiset tiedostojen ja kansioiden nimeämiskäytännöt ja noudata niitä johdonmukaisesti. Sovi yhtenäisistä nimeämiskäytännöistä tutkimusryhmän kanssa.Suunnitelman tulee olla niin tarkka ja laaja, että se kattaa koko tutkimuksesi aikaiset tarpeet. Nimeämissuunnitelman tavoitteina on

  • pystyä itse helposti tulkitsemaan, mitä tietoa kukin tiedosto sisältää (human readable filenames)
  • auttaa muita tiedostojesi hyödyntäjiä tulkitsemaan, mitä tietoa kukin tiedosto sisältää
  • huolehtia siitä, että nimet ovat koneluettavia (computer readable filenames)
  • pystyä pitämään kaikki tutkimuksesi tiedot tallessa ja loogisessa järjestyksessä.
  • Kansiorakenne: suunnittele aineistolle sopiva looginen kansiorakenne.
  • Versionhallinta.

Huolehdi siitä, ettet käytä tiedostojen ja kansioiden nimeämisessä henkilötietoja tai muuta sensitiivistä tietoa.

Laurea-kirjasto | Saavutettavuusseloste | Laurea Library | Accessibility statement