Readme.md in Ordnern
Was ist das?
Eine README.md-Datei ist eine Textdatei im Markdown-Format, die in einem sciebo-Ordner platziert werden kann. Nextcloud zeigt den Inhalt dieser Datei direkt am Anfang des Ordners an, sodass alle Nutzer*innen sofort auf wichtige Informationen zugreifen können.
Wofür wird es genutzt?
Die README.md dient dazu, Projektbeteiligten Hinweise, Anleitungen oder Kontextinformationen zu den im Ordner gespeicherten Dateien bereitzustellen. Beispielsweise können Sie erklären, wie Audiodateien aufgenommen wurden, was bei Transkriptionen zu beachten ist oder wie die Daten zitiert werden sollten.
Vorteile für Lehre und Forschung:
- Orientierungshilfe: Besonders bei größeren Projekten mit mehreren Nutzer*innen erleichtert eine README.md die Navigation und Nutzung der Ordnerinhalte.
- Einheitliche Standards: Sie können klare Richtlinien und Standards für die Nutzung und Bearbeitung der Dateien festlegen.
- Zeitersparnis: Neue Mitglieder des Projekts erhalten schnell alle notwendigen Informationen, ohne separate Dokumentationen lesen zu müssen.
Wie erstellen Sie eine README.md:
- Datei erstellen: Öffnen Sie den gewünschten Ordner in sciebo und erstellen Sie eine neue Datei mit dem Namen „README.md“.
- Inhalt hinzufügen: Nutzen Sie das Markdown-Format, um strukturierten Text zu verfassen. Beispielsweise:
# Projektname
## Einleitung
Hier finden Sie alle relevanten Dateien und Informationen zum Projekt.
## Inhalt
- Audiodateien: Aufnahme_XYZ
- Transkriptionen: Transkription_A
- Forschungsdaten: Datenblatt_1
- Speichern und anzeigen: Speichern Sie die Datei. Nextcloud zeigt den Inhalt automatisch am Anfang des Ordners an.