Data Management Skillbuilding Hub

Best Practice: How to write a Best Practice file

BEST PRACTICE

Best Practices by Data Life Cycle




How to write a Best Practice file

Data Life Cycle stage(s): Life cycle stage here

Filename

Each file is named as the first three words of the title, separated by dashes. This page’s title is “How to write a best practice”, therefore the filename is how-to-write.md.

The header (aka: front matter) for best practices has the following fields:

title: the title of the webpage, as it will appear in the lists

layout: is always bestpractice (NB this will likely be done automatically using the collections features from jekyll)

tags: a list of (short) keywords describing the content of the best practice text

step: a list of one or more steps of the data lifecycle to which this best practice applies

related: a list of related best practices identifiers – an identifier is the first three words of the title, separated by dashes (optional)

update: the date this best practice was created

author: a list of authors that created the best practice

organization: name of organization that oversaw the creation of the best practice

org_url: website of the organization, organization logo will open this webpage when selected

org_logo: name of the organization’s logo file, this must me a png

categories: this must be listed as [“Best Practice”], used for sorting and accessing education materials

in ‘Raw’ view, these are the headers you should have

content

  • thing 1
  • thing 2
    • another thing
    • one last thing

Description Rationale

content

Additional Information

a few things

Examples

content

Tags

Cite this best practice:

First and last name of person authoring the best practice, list separate bullet for each new person, DataONE  (May 08, 2018) "Best Practice: How to write a Best Practice file". Accessed through the Data Management Skillbuilding Hub at https://dataoneorg.github.io/Education/bestpractices/how-to-write on May 24, 2019


Home

Hosted by DataONE

In collaboration with the community, DataONE has developed high quality resources for helping educators and librarians with training in data management, including teaching materials, webinars and a database of best-practices to improve methods for data sharing and management.

Question If you have a question or concern, please open an Issue in this repository on GitHub.