DMPTuuli-opas: 3. Dokumentointi ja metatiedot

3.1 Miten dokumentoit aineistosi, jotta se on löydettävissä, saavutettavissa, yhteentoimivaa ja uudelleen käytettävissä sekä itseäsi että muita varten? Mitä metatietostandardeja, README-tiedostoja ja muuta dokumentaatiota käytät, jotta muut voivat ymmärtää ja käyttää aineistoasi?

Aineistoa koskeva dokumentaatio mahdollistaa sen, että muut käyttäjät (sekä ihmiset että tietokoneet) voivat löytää ja käyttää tietoaineistoja ja tiedostoja sekä viitata niihin asianmukaisesti.  

Tutkimusaineiston liitteeksi tarvitaan kuvailevaa ja teknistä tietoa siitä, mitä informaatiota se sisältää eli metadataa.

Metadataa on esimerkiksi tieto,

- miten ja milloin tutkimusaineisto on koottu

- mitä sopimuksia haastatteluaineistoihin tai muihin tutkimusaineistoihin liittyy

- miten tutkimusaineistoa on käsitelty tai anonymisoitu

- tiedot aineiston alkuperäisestä käyttötarkoituksesta ja saatavuudesta

- tiedostojen nimeämiskäytännöt, versionhallinta ja kansiorakenne

Tutkimusaineiston kuvaileminen lähtee aina tehdystä tutkimuksesta, sen menetelmistä ja luonteesta, tutkimusaineistojen tyypistä, rakenteesta ja sisällöstä.

Hyviä käytäntöjä

• Luettele dataan liitettävät kuvailudokumentit, esim. README-tiedostot, kyselylomakkeet.  
• Käytä tutkimusvälineitä ja mittauslaitteita, joiden luomat metatiedot ovat standardinmukaisia, jotta aineistosi on siirrettävissä eri valmistajien laitteiden välillä eli uudelleenkäytettävissä ja yhteentoimivaa.
• Arkistot edellyttävät usein tietyn metatietostandardin käyttämistä. Tarkista, onko käytettävissä ala-, yhteisö- tai arkistokohtaista metatietomallia tai -standardia.
• Ellei tutkimuksen aiheeseen sopivaa metadatastandardia ole olemassa, tämä on hyvä todeta.

Lisäohjeita

• Aineiston kuvailu ja metadata (Aineistonhallinnan käsikirja, Tietoarkisto)
• Disciplinary metadata standards (DCC)

Esimerkkejä

"The storage root as well as every sub-folder shall include a README.txt file. Each README.txt file describes the current naming conventions and purpose of all folders and files in that level of storage organization. Any additions, deletions or changes to naming conventions or purposes are immediately updated to README.txt."