Readme-Template für die Dokumentation von Forschungsdatensätzen
- GND
- 1286231450
- ORCID
- 0000-0003-4084-514X
- VIAF
- 573168172557348620002
- Affiliation
- Bauhaus-Universität Weimar
Dieses Readme-Template liegt in Markdown vor und ist eine Vorlage für die Dokumentation von Forschungsdatensätzen. Die Datei existiert in Deutscher und in Englischer Sprache und umfasst die Inhaltsschwerpunkte: Im Markdown-Syntax werden die Inhaltsschwerpunkte als Überschriften (mit Folgende Coffee Lecture kann als Erstinformation zu Bedeutung und Verwendung von ReadMe-Dateien genutzt werden. Das Template wurde ursprünglich als Begleitmaterial zur Verfügung gestellt:
#) versehen. Als normaler Text folgt eine Beschreibung des Inhalts. Template-Vorlagen für die Beschreibung benutzen den Code-Syntax (mit ```...```), um Fehlformatierungen in Markdown zu vermeiden. Darunter können ein oder mehrere Beispiele folgen, die als Kommentar eingefügt sind (mit <!--- ... --->). Es wird empfohlen, einen Texteditor zu verwenden, der die Markdown-Syntax lediglich hervorhebt, ohne sie direkt zu interpretieren, damit der Text weiterhin bearbeitbar bleibt. Für die Nutzung der Templates sollten die Beschreibungstexte und Beispiel-Kommentare entfernt und durch eigene Inhalte ersetzt werden.
"Forschungsdatenbeschreibung - Das Anlegen von Codebooks und Readme-Dateien"
Folien: https://doi.org/10.5281/zenodo.7569117
Video: https://www.youtube.com/watch?v=mr7AteFTh78
This README template is provided in Markdown format and serves as a guide for documenting research datasets. The file is available in both German and English and includes the following key sections: In Markdown syntax, the key sections are marked as headings (using The following coffee lecture can be used as an introduction to the importance and usage of README files. This template was originally provided as accompanying material:
#). Each heading is followed by a description of the content in plain text. Templates for the descriptions use code syntax (using ```...```) to prevent formatting errors in Markdown. Below these, one or more examples can be included as comments (using <!--- ... --->). It is recommended to use a text editor that highlights Markdown syntax without directly interpreting it, allowing the text to remain editable. When using the templates, the description texts and example comments should be removed and replaced with your own content.
"Research Data Description - Creating Codebooks and README Files"
Slides: https://doi.org/10.5281/zenodo.7569117
Video: https://www.youtube.com/watch?v=mr7AteFTh78
Cite
Rights
Use and reproduction:
