2 Minuten FDM: ReadMe
Die meisten Leute kennen ReadMe-Dateien von Software-Programmen – wo sie dann selten von Leuten, die nicht selber programmieren, gelesen werden. Doch ReadMe-Dateien haben auch jenseits der Software-Programmierung einen wichtigen Nutzen: Sie erklären das aktuelle Projekt, können Arbeitsweisen festlegen, z.B. Benennungsstandards und Ordnerstrukturen, und Details zu den Forschungsdaten enthalten.
Hier erhalten Sie einige Tipps zum Gebrauch von ReadMe-Dateien:
- ReadMe-Dateien müssen nicht lang sein. Keep it short and simple!
- Erläutern Sie Arbeitsweisen im Projekt, Ablagemethoden, verwendete Abkürzungen und Standards.
- Sie können auch Änderungen im ReadMe dokumentieren.
- Fügen Sie in jeden Ordner oder zu jeder Datei eine ReadMe-Datei hinzu, der oder die nähere Erläuterungen braucht.
- Speichern Sie die Dateien als im .txt oder .md Format. So können sie auf jedem Computer geöffnet werden. Im md-Format (md = markdown) können Sie Texte mit einfachen Mitteln formatieren. Mehr Informationen zu Markdown finden Sie z.B. hier.
- Vermerken Sie Ansprechpersonen im ReadMe, um Nachfragen zu ermöglichen. Bei publizierten Datensätzen sollte eine E-Mail-Adresse hinterlegt werden, die langfristig aktiv ist.
- Für das erstellen von ReadMe-Dateien für Software (die auch in den Bereich „Forschungsdaten“ gehören kann) gibt es gute Hilfen im Internet, z.B. bei www.makeareadme.com.
... ist Mitarbeiterin im Referat PID- und Metadaten Services der TIB und dort vor allem für das Projekt PID Network zuständig.
