Published February 11, 2025 | Version v1

From Data to Credits: Using ReadMe, Markdown, and Dublin Core for Better Documentation

Authors/Creators

  • 1. Center for Interdisciplinary Digital Sciences
  • 2. ROR icon Technische Universität Dresden

Description

Howto for a simple ReadMe in flavor of the Love Data Week 2025 presented at SLUB Open Science Lab for using plain Markdown and Dublin Core to annotate your data . See the file "ReadMe.md" for an example.

Furthermore, as this ReadMe follows a straightforward structure given by section and text, simplistic parsing can be used to extract and validate the metadata and to streamline the documentation process. One implementation of a parser written in python to convert Markdown to JSON files can be found here.

Link to Poster: https://doi.org/10.5281/zenodo.15127381
Link to Markdown-to-JSON-Parser: https://doi.org/10.5281/zenodo.14942696 and https://github.com/Bondoki/ParsingMetadataMD2JSON

Files

FromDataToCredits.pdf

Files (174.0 kB)

Name Size Download all
md5:0078adf63a7d07efa398897a5acfef1b
170.7 kB Preview Download
md5:d16e01ce2d2f6bac18e988a21607c200
3.3 kB Preview Download

Additional details

Related works

Is referenced by
Poster: 10.5281/zenodo.17463773 (DOI)
Is supplemented by
Poster: 10.5281/zenodo.15127381 (DOI)
Software: 10.5281/zenodo.14942696 (DOI)
Software: https://github.com/Bondoki/ParsingMetadataMD2JSON (URL)
Is variant form of
Publication: 10.5281/zenodo.10648864 (DOI)