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:
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