Dokumentera dataset i en README-fil

README-filen dokumenterar och beskriver innehållet i ett dataset

En README-fil beskriver strukturerat innehållet i ett dataset och är ett enkelt sätt att underlätta för förståelsen för och användningen av datan. Det gäller både under projektet och i framtiden, såväl för projektmedlemmarna som eventuellt för andra som kan vara intresserade. Beskrivningen ska svara på frågorna vem, vad, när, var, varför och hur data har genererats i studien, så att det framgår hur data kan användas även i andra sammanhang och inom andra discipliner. 

README-filen ska enkelt kunna lokaliseras och läsas utan särskild programvara, så det är bra att spara den i anslutning till datasetet och som en ren textfil.  

Många datarepositorier rekommenderar att publicerade dataset innehåller README-filer, för att det ska bli så enkelt som möjligt för andra att ta del av och eventuellt återanvända dina data.

Det här ska finnas i en README-fil

En README-fil ska bland annat dokumentera: 

• Hur data och andra filer är organiserade 
• Hur data har genererats och analyserats 
• Vilka eventuella restriktioner som påverkar hur data kan återanvändas 
• Vilka standarder som används i datafiler och dokumentation  

Så använder du README-filer

Använd mallen nedan för att skapa en README-fil. Använd de delar av mallen som är relevanta och lägg till rubriker som underlättar förståelsen. Spara den sedan överst i mappstrukturen som ren text (i formatet .txt). Det är viktigt att filen heter README (alltså sparas med detta filnamn). Skriv texten i dokumentet på engelska för att så många som möjligt ska kunna förstå och använda den. Om mappen innehåller undermappar med dataset kan README-filer med fördel skapas för respektive dataset. Uppdatera informationen i filen löpande.  

Informationen i README-filen i forskningsdatamappen kommer också att användas vid arkiveringen av datasetet, vilket underlättar både för forskare och andra som kan vara involverade i arkiveringen. 

Mall för README-fil i formatet .txt