README Files are a common way to document the contents and structure of a folder and/or a dataset so that a researcher can locate the information they need. Data documentation can be maintained in a variety of forms. Explore additional Documentation & Metadata practices.

What is a README File?

Provide a clear and concise description of all relevant details about data collection, processing, and analysis in a README file. This will help others interpret and reanalyze your dataset.

README files are created for a variety of reasons:

  • to document changes to files or file names within a folder
  • to explain file naming conventions, practices, etc. "in general" for future reference
  • to specifically accompany files/data being deposited in a repository
     

It is best practice to create a README file for each dataset regardless of whether it is being deposited in a repository because the document might become necessary later.

  • A good data practice is to store a readme.txt with each distinct dataset that explains your file naming convention along with any abbreviations or codes you have used.
  • Write your README file as a plain text file, and avoid proprietary formats, such as Microsoft Word, whenever possible. However, PDF is acceptable when formatting is important.
  • If you deposit your final datasets in a data repository, the repository may ask you to provide a README file with additional details about your datasets, such as methodological information or sharing/access information. Creating a README file at the beginning of your research process, and updating it consistently throughout your research, will help you to compile a final README file when your data is ready for deposit.
     

README Resources

What's in a README?
RDM Seminar Recorded Summer 2020
Watch the following video to get started with README Files

Download PDF Presentation Slides | Download PDF Presentation with Notes