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.