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

Research output: Preprint/Documentation/Report › Technical and data(set) papers/manual

Abstract

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.15127381Link to Markdown-to-JSON-Parser: https://doi.org/10.5281/zenodo.14942696 and https://github.com/Bondoki/ParsingMetadataMD2JSON

Details

Original languageGerman
Publication statusPublished - 11 Feb 2025
No renderer: customAssociatesEventsRenderPortal,dk.atira.pure.api.shared.model.researchoutput.WorkingPaper

Keywords