ReadMe-Datei

Was ist eine ReadMe-Datei?

Eine ReadMe-Datei ist eine zumeist menschenlesbare Datei in einem Textformat. Sie enthält administrative und beschreibende Metadaten zu einem begleitenden Datensatz. Durch diese Angaben soll der Datensatz interpretierbar sein und besser nachgenutzt werden können. Die Datei kann beschreibenden Informationen wie z.B. Messparameter und Verarbeitungsschritte enthalten sowie strukturelle Informationen wie z.B. eine Übersicht über Einzeldateien eines Datenpaketes.

Eine ReadMe-Datei für Forschungsdaten ist nicht identisch mit den üblichen ReadMe-Dateien aus der Software-Entwicklung.

Die ReadMe-Datei sollte folgende Inhalte auflisten:

Allgemeine Informationen:
- Titel des Datensatzes
- Informationen zur Autorenschaft inkl. Kontaktdaten, ORCID und Institutionszugehörigkeit
- Datum/Zeitraum und Geografischer Bezug der Datenerhebung
- Fachdisziplin, Schlagworte, Abstract, Forschungsfrage
- Informationen über externe Förderer und Mittelgeber des Forschungsprojektes
Informationen zur Weitergabe/Zugang:
- Lizenzen/Einschränkungen
- Links zu Veröffentlichungen, in denen die Daten zitiert werden
- Links zu anderen öffentlich zugänglichen Datenquellen (Repositorien, etc.)
- Links zu ergänzenden Datensätzen
- Wurden die Daten aus einer anderen Quelle abgeleitet?
- Empfohlene Zitierweise für den Datensatz
Daten- und Datei-Übersicht inkl. Beziehungen zwischen den Dateien und Angaben zu Versionen
Methodische Informationen:
- Beschreibung der für die Erhebung/Erstellung und Verarbeitung der Daten verwendeten Methoden
- Geräte- oder softwarespezifische Informationen, die zur Interpretation der Daten benötigt werden
- Standards und Kalibrierung
- Umwelt-/Experimentelle Bedingungen
- Beschreibung der Qualitätssicherungsverfahren für die Daten
- An der Probenahme, -verarbeitung, -analyse und -übermittlung beteiligte Personen
Datenspezifische Informationen:
- Anzahl der Variablen sowie der Fälle/Zeilen
- Variablenliste
- Codes für fehlende Daten
- Spezialisierte Formate oder andere verwendete Abkürzungen

Bei der Erstellung einer Readme-Datei sollten folgende Bedingungen eingehalten werden:

kurzer und einfacher Text
offenes Format (z.B. .txt oder .md)
Verknüpfung zum beschreibenden Datensatz
Aktualisierung der Datei bei wesentlichen Änderungen am Datensatz

Templates für ReadMe-Dateien

README-template by Cornell University Library: https://data.research.cornell.edu/data-management/sharing/readme/
README-Vorlage der Technischen Universität Braunschweig: https://www.tu-braunschweig.de/fileadmin/Redaktionsgruppen/Einrichtungen/UB/README_Template_TUBS.txt
Readme-Template aus dem Train-the-Trainer-Konzept zum Thema Forschungsdatenmanagement (Version 5) von Biernacka, K. et al. (2023). https://doi.org/10.5281/zenodo.5773203 (siehe unter Begleitmaterialien)

1. Erstellen Sie zu Ihren Forschungsdaten mind. eine ReadMe-Datei. 2. Nutzen Sie innerhalb ihres Forschungsprojektes und zu den verschiedenen entstandenen Forschungsdaten ein Template für die ReadMe-Datei oder erstellen Sie ein einheitliches Template nach Ihren Anforderungen.

Quellen

Webseite der TU Braunschweig: https://www.tu-braunschweig.de/forschung/forschungsdaten-transparenz/forschungsdaten/grundkurs-forschungsdatenmanagement/datenorganisation-dokumentation/metadaten (16.05.2025)
Annika Rockenberger. (2021, September 9). Shut Up And Write Documentation: README.txt. Zenodo. https://doi.org/10.5281/zenodo.5497583