Eine Dokumentation der Ordnerstruktur und Dateibenennungen sollte in einer separaten (.txt) Datei auf oberster (Baum-)Ebene aufbewahrt werden. Sogenannte README-Dateien dienen dazu, Festlegungen zur Struktur und Benennung von Dateien und Ordnern übersichtlich und schnell nachvollziehbar festzuhalten. Sie können beispielsweise als .txt-Dateien oder als Markdown-Dateien (.md) abgelegt werden.

Vorteile einer README:
  • Übersichtliche Textdatei neben den Daten
  • Erstellung geht meistens sehr schnell
  • Spezielle Software wird nicht benötigt
  • Macht die Überlegungen zur Dateibenennung und Ordnerstruktur für andere Nutzende und einen selbst zu einem späteren Zeitpunkt jederzeit nachvollziehbar
  • Nützlich für die Auflösung von Abkürzungen und Namenskürzeln

Was sollte in einer README stehen?
  • Wer? (Name und Kontaktinformation)
  • Was? (Beschreibung der Daten, Formate, Designs, etc.)
  • Wann? (Letztes aktives Datum)
  • Wo? (Welche Dateien sind wo zu finden?)
  • Warum? (Was ist der Zweck dieser Dateien?)

Ebenfalls hilfreich:

  • Formulierung von Regeln für Zugang und Nachnutzung (Was darf mit den Daten gemacht werden?)
  • Hinweise auf Datenquellen / Zitationshinweise für die Wiederverwendung der Daten
Glühbirne IconTIPP: Die Beschreibung des eigenen Umgangs mit den Daten in einer README-Datei ist ein guter Anfang. Eine umfangreichere Variante, die noch detaillierter auf ein Projekt, das Management der Daten, die Speicherung und Veröffentlichung von Daten eingeht, wird als 'Datendokumentation' oder auch 'Datenmanagementplan' bezeichnet.