Tutkimusaineiston README-tiedostot
Tutkimusaineiston yhteydestä tulisi aina löytyä sen sisältöä kuvaava ja dokumentoiva README-tiedosto. Tältä sivulta löydät muutamia esimerkkejä tutkimusaineiston dokumentoimisesta README-tiedoston avulla
Readme-tiedostossa tulee kuvailla lyhyesti aineiston yleiset perusmetatiedot (hankkeen nimi, tekijät, aineiston omistaja, linkki JYXissä julkaistuihin metatietoihin), kuvata kansiorakenne ja tiedostojen sekä kansioiden nimeämiskäytänteet. Mikäli muu aineiston käyttöön liittyvä dokumentaatio on kätevää kuvata samaan tiedostoon, on sekin mahdollista.
Readme-tiedostot tulee järjestää loogisesti, tarpeellisia väliotsikoita käytten ja käyttäen kieltä, joka on yleisesti tutkijoiden ymmärrettävissä ilman muuta kontekstitietoa alasta tai hankkeesta.
Cornellin yliopisto on laatinut kattavan pohjan Readme-tiedoston rakentamisesta, jota suositellaan käytettäväksi myös meillä.