Tijdens je onderzoek is het nuttig om je gegevens volgens de FAIR-principes te documenteren, zodat je transparant werkt en zodat de gegevens in de toekomst begrijpelijk zijn voor jezelf en voor anderen. Documentatie toevoegen is een continu proces, waarbij je het hele project kunt beschrijven: van het plannen van je onderzoek tot de afronding van je onderzoek.
Onderzoek plannen
Documentatie over praktische zaken kan al aan het begin van het project worden toegevoegd en kan gedurende het hele project als nuttig referentiedocument dienen. Bijvoorbeeld, afspraken of beslissingen over bestandsnamen, het structureren van mappen, versiebeheer of teamworkflow kunnen nuttig zijn tijdens het hele project.
Tijdens het onderzoek
Tijdens het verzamelen van en werken aan je data is het perfecte moment om het grootste deel van je documentatie toe te voegen. Leg bijvoorbeeld concepten, variabelen en codes in je dataset gedetailleerd vast in een codeboek of voeg notities toe aan je literatuuroverzicht. In een readme kun je uitleggen hoe je data hebt getransformeerd: heb je transcripties gemaakt, heb je gehercodeerd, geaggregeerd (van datasets, data of variabelen), hoe ben je omgegaan met ontbrekende variabelen, heb je de data geanonimiseerd?
Afronding van het onderzoek
Voeg bij het archiveren en/of publiceren van je data documentatie toe die de context achter de dataset uitleggen en informatie bevatten over hoe het onderzoek is uitgevoerd. Zo zorg je ervoor dat je data begrijpelijk is, geverifieerd en eventueel gereproduceerd kan worden. Dit kun je doen door voldoende metadata toe te voegen, maar ook door documentatie toe te voegen over de geschiedenis van het project, de doelstellingen, hypotheses, methoden, etc. Combineer dit met de documentatie die je in de vorige fasen van je project hebt geschreven.
Vereisten van documenteren
De documentatie van je onderzoek moet sowieso bestaan uit:
- Een readme bestand: dit is het eerste bestand dat gebruikers moeten openen en moet dus alles bevatten wat ze moeten weten. Het beschrijft de context, inhoud en structuur van de dataset of verwijst duidelijk naar andere documentatiebestanden die dat doen, zoals een codeboek.
- Metadata: maak volledig gebruik van de metadatavelden die je in de meeste archieven en depots vindt. Aan sommige metadatavelden zoals titel, beschrijvingen en trefwoorden denk je misschien snel, maar ook taal, tijdsperiode en locatie van de dataverzameling zijn erg nuttig voor gebruikers.