Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: improved accessibility

The guide is copied from the Cornell University, Research Data Management Service Group (https://data.research.cornell.edu/content/readme) under under the Creative Commons Attribution 4.0 International License. 

...

Want a template? Download one and adapt it for your own data: cornell.box.com/v/ReadmeTemplate

Best practices

  • Create readme files for logical “clusters” of data. In many cases it will be appropriate to create one document for a dataset that has multiple, related, similarly formatted files, or files that are logically grouped together for use (e.g. a collection of Matlab scripts). Sometimes it may make sense to create a readme for a single data file.
  • Name the readme so that it is easily associated with the data file(s) it describes.
  • Write your readme document as a plain text file, avoiding proprietary formats such as MS Word whenever possible. Format the readme document so it is easy to understand (e.g. separate important pieces of information with blank lines, rather than having all the information in one long paragraph).
  • Format multiple readme files identically. Present the information in the same order, using the same terminology.
  • Use standardized date formats. Suggested format: W3C/ISO 8601 date standard, which specifies the international standard notation of YYYY-MM-DD or YYYY-MM-DDThh:mm:ss.
  • Follow the scientific conventions for your discipline for taxonomic, geospatial and geologic names and keywords. Whenever possible, use terms from standardized taxonomies and vocabularies, a few of which are listed below.
SourceContentURL
Getty Research Institute Vocabulariesgeographic names, art & architecture, cultural objects, artist nameshttp://www.getty.edu/research/tools/vocabularies/
Integrated Taxonomic Information Systemtaxonomic information on plants, animals, fungi, microbeshttp://www.itis.gov/
NASA Thesauriengineering, physics, astronomy, astrophysics, planetary science, Earth sciences, biological scienceshttps://www.sti.nasa.gov/nasa-thesaurus/
GCMD KeywordsEarth & climate sciences, instruments, sensors, services, data centers, etc.https://earthdata.nasa.gov/earth-observation-data/find-data/gcmd/gcmd-keywords
The Gene Ontology Vocabularygene product characteristics, gene product annotationhttp://amigo.geneontology.org/amigo/dd_browse
USGS Thesauriagriculture, forest, fisheries, Earth sciences, life sciences, engineering, planetary sciences, social sciences etc.https://www1.usgs.gov/csas/biocomplexity_thesaurus/index.html
IUPAC Gold Bookcompendium of chemical terminology from the International Union of Pure and Applied Chemistry (IUPAC)https://goldbook.iupac.org

...

The preceding guidelines have been adapted from several sources, including:

Best practices for creating reusable data publications. Dryad. 2019. https://datadryad.org/stash/best_practices

Introduction to Ecological Metadata Language (EML). The Knowledge Network for Biocomplexity. 2012. https://web.archive.org/web/20120424124714/http://knb.ecoinformatics.org/eml_metadata_guide.html