Published January 17, 2024 | Version 20240117
Other Open

WUR documentation templates, guidance, and examples.

  • 1. Wageningen University & Research

Description

WUR Library - RDM support developed the WUR documentation templates, guidance, and examples to assist researchers in documenting data. The files in the package can be used independently of whether the data is archived at WUR or published in a repository. Where appropriate, a template is provided that is not filled in for a specific project and often has guidance contained within, and a filled in example of the template is provided for a fictitious project.

Note that the metadata json files contain an empty template and a filled in version. The empty template is just a download from the publicly available Yoda metadata editor at https://utrechtuniversity.github.io/yoda-portal/, while the filled in version is filled in using the publicly available Yoda metadata editor. Please use the Yoda metadata editor to create such a json file. The version of the empty template is depicted by 'default-n' where 'n' is a number depicting the latest version of the template (this is the name assigned to the default available metadata template within the Yoda system).

Note that the readme template is provided in both a text (txt) format and a markdown (md) format. The information is the same between formats, but the markdown format has markdown formatting to display that information. For markdown files, the content is also provided as rendered html formats. Use a markdown (pre)viewer to view md output (notepad++ with the plugin 'MarkdownPanel' is a nice editor, previewer, and viewer).

See the version history txt file for indication of changes made.

Notes

Please ignore the Zenodo preview and scroll down to the files below. The filled examples are partially based on the project described in the fictional data management plan (https://doi.org/10.5281/zenodo.7096699, see 'related identifiers').

Files

WUR_research_documentation_templates.zip

Files (134.5 kB)

Name Size Download all
md5:7e0b14b73e609444da5d7917217c839a
134.5 kB Preview Download

Additional details

Related works

Is documented by
Output management plan: 10.5281/zenodo.7096699 (DOI)