Readme-Template für die Dokumentation von Forschungsdatensätzen

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: Projekttitel (Project Title) Beschreibung (Description) Mitwirkende (Contributor Roles) Zitation (Citation) Struktur des Datensatzes (Structure of the dataset) Materialien und Methoden (Materials and methods) Erste Schritte (Getting started) Lizenz (License) Danksagungen (Acknowledgments) Kontakt (Contact) Zusätzliche Hinweise (Additional Notes) Im Markdown-Syntax werden die Inhaltsschwerpunkte als Überschriften (mit #) 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. 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: "Forschungsdatenbeschreibung - Das Anlegen von Codebooks und Readme-Dateien" Folien: https://doi.org/10.5281/zenodo.7569117 Video: https://www.youtube.com/watch?v=mr7AteFTh78