diff --git a/README.md b/README.md index 2e88943..6dfe25a 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,30 @@ -# Good™ Documentation - -Dieses Repository enthält eine Beispielstruktur, nach welchen Regeln und in -welcher Ausführlichkeit sinnvoll dokumentiert werden sollte. +--- +title: Good™ Documentation +description: | + Dieses Repository enthält eine Beispielstruktur, nach welchen Regeln und in welcher Ausführlichkeit sinnvoll dokumentiert werden sollte. +lang: de +date: 2025-06-03 +authors: + - name: Nicole Dresselhaus + affiliation: + - name: Humboldt-Universität zu Berlin + url: https://hu-berlin.de + email: nicole.dresselhaus@hu-berlin.de + correspondence: true + orcid: 0009-0008-8850-3679 + roles: + - Conceptualization + - "Writing – first draft" + - "Writing – review & editing" + - name: Till Grallert + affiliation: + - name: Humboldt-Universität zu Berlin + url: https://hu-berlin.de + email: till.grallert@hu-berlin.de + roles: + - Supervision + - Validation +--- ## Ziel / Zweck @@ -37,33 +60,22 @@ um ein Applikationsprojekt im klassischen Sinne handelt. Ziel ist hier die Entwicklung und langfristig die Installation, Veröffentlichung,Nutzung und Wartung der Software. -Das Template enthält folgende Struktur: - -```plain -. -├── .gitlab (issue-templates für GitLab) -├── CHANGELOG.md (CHANGELOG-Beispiel für Releases) -├── CITATION.md (Wie die Software zitieren?) -├── CONTRIBUTING.md (Wie bei der Software mithelfen?) -├── INSTALL.md (Wie die Software installieren?) -├── README.md (Genereller Überblick) -├── src (Beispielverzeichnis für den eigentlichen Code) -└── USAGE.md (Wie nutze ich die Software?) -``` - -Die Dateien enthalten jeweils eine Anleitung über ihren Inhalt +Zur genauer Struktur und Handhabung sei auf die `README.md` dort verwiesen. ### Daten-Project -**Ein ähnliches Projekt für Daten-Repositories ist in Planung.** - -Das Template ist für Repositories gedacht, die Daten aus Quellen erstellen, -aufbereiten und wieder zur Verfügung stellen. Beispiele wären z.b. Bilder ~> -annotierter Korpus. +Analog zum Code-Project ist das +[Daten-Project-Template](https://scm.cms.hu-berlin.de/methodenlabor/templates/data-project-template) +für Repositories gedacht, die irgendeine Art von Daten als Output haben. Hierbei +geht es um die reine Vorverarbeitung der Daten und nicht um Analyse. +Typischerweise liegen hier z.b. Roh-Daten (Bilder, etc.) vor und der Output ist +ein Maschinenlesbares Format (z.b. JSON des Textes mit Annotationen). Ziel ist hier die Dokumentation und die Reproduzierbarkeit von `Quelle -> Datensatz`. +Zur genauer Struktur und Handhabung sei auf die `README.md` dort verwiesen. + ## Wissenschaftlicher Hintergrund Dieses gesamte Repository wurde erstellt um Forschenden eine fundierte, @@ -74,7 +86,7 @@ dokumentieren. Insbesondere hervorzuheben sind hier die [Ten simple rules for documenting scientific software](https://doi.org/10.1371/journal.pcbi.1006561). Für eine Ausführliche auseinandersetzung mit dieser Thematik siehe -`BACKGROUND.md` +[BACKGROUND.md](background/BACKGROUND.md) ## Bekannte Einschränkungen