God dokumentasjon er med på å styrke kvaliteten på dataene og dine resultater ved å gjøre funn etterprøvbare, dokumentasjon noteres vanligvis underveis som en integrert del av forskningsmetoden.
I motsetning til metadata, er det ikke nødvendig at dokumentasjon følger en standard. Det er likevel en del ting som er viktig å få med. Dokumentasjon skrives underveis i arbeid med dataene, og oppsummeres og legges ved data som arkiveres som en ReadMe-fil.
I gjennomføringsfasen
Gode rutiner for å dokumentere hva som gjøres i prosessen med innsamling, bearbeiding og analyse er del av metode og god forskningspraksis. Hvordan du velger å dokumentere arbeidet, vil ofte avhenge av fag.
Eksempel på verktøy du kan bruke for dokumentasjon inkluderer:
- et rent tekstdokument.
- notatbokverktøy som OneNote (inkludert i Microsoft 365).
- elektroniske labnotatbøker (ELN). UiO har avtale med eLabJournal.
- dokumentasjon på papir (feltdagbøker ol.) som avfotograferes/digialiseres og legges ved digitale data.
Ved avslutning og arkivering
Når data skal arkiveres, legges dokumentasjon i en ReadMe-fil. En ReadMe-fil er en detaljert veiledning til datasettet som gjør det mulig for andre forskere å forstå og gjenbruke dataene du arkiverer.
Det er det viktig at dokumentasjonen ved arkivering inneholder generell informasjon om prosjektet, lisens, informasjon om gjenbruk, oversikt over filene, metodeinformasjon og dataspesifikk informasjon om innholdet i de ulike filene.
En komplett filoversikt er viktig både for arkiv og gjenbruk for å sikre at datasettet er komplett. Metodeinformasjon hentes gjerne fra artikler tilknyttet datasettet, men det er også rom for flere detaljer i det som legges inn i en ReadMe-fil. Mye dokumentasjonen som trengs for arkivering er dataspesifikk informasjon denne hentes fra notatbøker som skrives underveis i forskningen. Det er også vanlig å legge ved dokumentasjon fra gjennomføringsfasen i sin helhet og vise til detaljer i denne i ReadMe-filen.
Les mer om arkivering av data.
ReadMe-mal
For å lage en god ReadMe-fil tilpasset arkivering av data er det hensiktsmessig å bruke en mal. DataverseNO har en grundig og oppdatert ReadMe-fil mal for datasett og en annen mal tilpasset arkivering av programvare eller kode.
ReadMe-filer bør lagres i rent tekst format (.txt) med Unicode UTF-8-tegnsetting og ha filnavnet «00_ReadMe.txt» slik at den vil sorteres øverst i en filstruktur.