start

README.md

@@ -1,93 +1,60 @@
-# Documentation
+# Good™ Documentation
 
+Dieses Repository enthält eine Beispielstruktur, nach welchen Regeln und in
+welcher Ausführlichkeit sinnvoll dokumentiert werden sollte.
 
+## Ziel / Zweck
 
-## Getting started
+Dokumentation ist hilfreich, dennoch fällt sie meist anderen Sachzwängen zum
+Opfer. Dieses Repository bietet diverse Markdown-Dateien als ausfüllbare
+Vorlage, damit man sich auf das wesentliche konzentrieren kann bzw. wichtige
+Dinge für etwaige Nachfolger\*innen nicht vergisst.
 
-To make it easy for you to get started with GitLab, here's a list of recommended next steps.
+## Nutzung
 
-Already a pro? Just edit this README.md and make it your own. Want to make it easy? [Use the template at the bottom](#editing-this-readme)!
+Das Unterverzeichnis `example-project` enthält folgende Struktur:
 
-## Add your files
-
-- [ ] [Create](https://docs.gitlab.com/ee/user/project/repository/web_editor.html#create-a-file) or [upload](https://docs.gitlab.com/ee/user/project/repository/web_editor.html#upload-a-file) files
-- [ ] [Add files using the command line](https://docs.gitlab.com/topics/git/add_files/#add-files-to-a-git-repository) or push an existing Git repository with the following command:
-
-```
-cd existing_repo
-git remote add origin https://scm.cms.hu-berlin.de/methodenlabor/doc_documentation.git
-git branch -M main
-git push -uf origin main
+```plain
+example-project/
+├── README.md
+├── INSTALL.md         (optional, bei aufwendiger Installation)
+├── USAGE.md           (optional, bei komplexeren Beispielen oder Workflows)
+├── CONTRIBUTING.md    (optional, falls Mitarbeit möglich)
+├── CITATION.md        (oder CITATION.cff)
+├── LICENSE
+├── CHANGELOG.md       (optional)
+├── examples/          (optional, Beispielskripte oder Notebooks)
+│   └── example_workflow.ipynb
+├── data/              (optional, kleine Beispieldaten)
+│   └── sample_data.csv
+└── src/
+    ├── script.py
+    └── module/
+        └── helper.py
 ```
 
-## Integrate with your tools
+Die jeweiligen benötigten Dateien können einfach kopiert werden und enthalten
+jeweils eine Anleitung über ihren Inhalt
 
-- [ ] [Set up project integrations](https://scm.cms.hu-berlin.de/methodenlabor/doc_documentation/-/settings/integrations)
+## Wissenschaftlicher Hintergrund
 
-## Collaborate with your team
+Dieses gesamte Repository wurde erstellt um Forschenden eine fundierte,
+praktische Hilfe zu geben, um ihre Projekte nach guten Standards zu
+dokumentieren. Insbesondere hervorzuheben sind hier die
+[Endings-Principles for Digital Longevity](https://endings.uvic.ca/principles.html),
+[FAIR-Principles](https://www.go-fair.org/fair-principles/) und den
+[Ten simple rules for documenting scientific software](https://doi.org/10.1371/journal.pcbi.1006561).
 
-- [ ] [Invite team members and collaborators](https://docs.gitlab.com/ee/user/project/members/)
-- [ ] [Create a new merge request](https://docs.gitlab.com/ee/user/project/merge_requests/creating_merge_requests.html)
-- [ ] [Automatically close issues from merge requests](https://docs.gitlab.com/ee/user/project/issues/managing_issues.html#closing-issues-automatically)
-- [ ] [Enable merge request approvals](https://docs.gitlab.com/ee/user/project/merge_requests/approvals/)
-- [ ] [Set auto-merge](https://docs.gitlab.com/user/project/merge_requests/auto_merge/)
+Für eine Ausführliche auseinandersetzung mit dieser Thematik siehe
+`BACKGROUND.md`
 
-## Test and Deploy
+## Bekannte Einschränkungen
 
-Use the built-in continuous integration in GitLab.
+Dieses Repository sollte nicht als der einzig richtige Weg angesehen werden,
+sondern ist eher ein Aufschlag, Erkenntnisse in der eigenen Arbeit auch
+praktisch umzusetzen. Jede hier aufgestellte Regel und Empfehlung kann und
+sollte - je nach Umständen - auch gebrochen werden.
 
-- [ ] [Get started with GitLab CI/CD](https://docs.gitlab.com/ee/ci/quick_start/)
-- [ ] [Analyze your code for known vulnerabilities with Static Application Security Testing (SAST)](https://docs.gitlab.com/ee/user/application_security/sast/)
-- [ ] [Deploy to Kubernetes, Amazon EC2, or Amazon ECS using Auto Deploy](https://docs.gitlab.com/ee/topics/autodevops/requirements.html)
-- [ ] [Use pull-based deployments for improved Kubernetes management](https://docs.gitlab.com/ee/user/clusters/agent/)
-- [ ] [Set up protected environments](https://docs.gitlab.com/ee/ci/environments/protected_environments.html)
+## Lizenz & Zitation
 
-***
-
-# Editing this README
-
-When you're ready to make this README your own, just edit this file and use the handy template below (or feel free to structure it however you want - this is just a starting point!). Thanks to [makeareadme.com](https://www.makeareadme.com/) for this template.
-
-## Suggestions for a good README
-
-Every project is different, so consider which of these sections apply to yours. The sections used in the template are suggestions for most open source projects. Also keep in mind that while a README can be too long and detailed, too long is better than too short. If you think your README is too long, consider utilizing another form of documentation rather than cutting out information.
-
-## Name
-Choose a self-explaining name for your project.
-
-## Description
-Let people know what your project can do specifically. Provide context and add a link to any reference visitors might be unfamiliar with. A list of Features or a Background subsection can also be added here. If there are alternatives to your project, this is a good place to list differentiating factors.
-
-## Badges
-On some READMEs, you may see small images that convey metadata, such as whether or not all the tests are passing for the project. You can use Shields to add some to your README. Many services also have instructions for adding a badge.
-
-## Visuals
-Depending on what you are making, it can be a good idea to include screenshots or even a video (you'll frequently see GIFs rather than actual videos). Tools like ttygif can help, but check out Asciinema for a more sophisticated method.
-
-## Installation
-Within a particular ecosystem, there may be a common way of installing things, such as using Yarn, NuGet, or Homebrew. However, consider the possibility that whoever is reading your README is a novice and would like more guidance. Listing specific steps helps remove ambiguity and gets people to using your project as quickly as possible. If it only runs in a specific context like a particular programming language version or operating system or has dependencies that have to be installed manually, also add a Requirements subsection.
-
-## Usage
-Use examples liberally, and show the expected output if you can. It's helpful to have inline the smallest example of usage that you can demonstrate, while providing links to more sophisticated examples if they are too long to reasonably include in the README.
-
-## Support
-Tell people where they can go to for help. It can be any combination of an issue tracker, a chat room, an email address, etc.
-
-## Roadmap
-If you have ideas for releases in the future, it is a good idea to list them in the README.
-
-## Contributing
-State if you are open to contributions and what your requirements are for accepting them.
-
-For people who want to make changes to your project, it's helpful to have some documentation on how to get started. Perhaps there is a script that they should run or some environment variables that they need to set. Make these steps explicit. These instructions could also be useful to your future self.
-
-You can also document commands to lint the code or run tests. These steps help to ensure high code quality and reduce the likelihood that the changes inadvertently break something. Having instructions for running tests is especially helpful if it requires external setup, such as starting a Selenium server for testing in a browser.
-
-## Authors and acknowledgment
-Show your appreciation to those who have contributed to the project.
-
-## License
-For open source projects, say how it is licensed.
-
-## Project status
-If you have run out of energy or time for your project, put a note at the top of the README saying that development has slowed down or stopped completely. Someone may choose to fork your project or volunteer to step in as a maintainer or owner, allowing your project to keep going. You can also make an explicit request for maintainers.
+Folgt...

example-project/CHANGELOG.md

@@ -0,0 +1,11 @@
+# Changelog
+
+Dokumentation der Änderungen pro Version:
+
+## [v1.0.0] – 2025-05-08
+
+- Erste stabile Version
+
+## [v0.1.0] – 2025-03-15
+
+- Erstes öffentliches Release

example-project/CITATION.md

@@ -0,0 +1,9 @@
+# Wie wird die Software zitiert?
+
+Nenne hier die bevorzugte Zitierweise für Publikationen oder DOI:
+
+```markdown
+Nachname, Vorname. (Jahr). Projektname (Version X.Y.Z). DOI oder URL.
+```
+
+- **Keine langen Beschreibungen**, nur den Zitierhinweis.

example-project/CONTRIBUTING.md

@@ -0,0 +1,16 @@
+# Wie beiträgt man zum Projekt?
+
+Anleitung zur Mitarbeit am Projekt.
+
+## Bugs melden & Vorschläge
+
+Wie meldet man Fehler oder schlägt Features vor? (z.B. Issue Tracker)
+
+## Code beisteuern
+
+Richtlinien für Codequalität und Beiträge:
+
+- Wie erstelle ich einen Pull Request?
+- Gibt es Stilrichtlinien (z.B. PEP8 für Python)?
+
+- **Nicht überkomplizieren**, sondern klaren Workflow beschreiben.

example-project/INSTALL.md

@@ -0,0 +1,14 @@
+# Installation
+
+Ausführliche Schritt-für-Schritt Anleitung zur Installation.
+
+## Voraussetzungen
+
+Hier alle Abhängigkeiten (z.B. Python-Version, Pakete, externe Tools) listen.
+
+## Schritte zur Installation
+
+Detaillierte Installationsanweisungen (Code-Blöcke, Terminal-Befehle).
+
+- **Nicht ausführlich Grundlagen erklären**, stattdessen verlinken auf externe
+  Ressourcen.

example-project/LICENSE

@@ -0,0 +1,5 @@
+MIT License (Beispiel)
+
+Copyright (c) 2025 Name
+
+Permission is hereby granted, free of charge, to any person obtaining a copy...

example-project/README.md

@@ -0,0 +1,47 @@
+# Projektname
+
+Kurze Beschreibung (2-3 Sätze), was die Software macht und welches
+wissenschaftliche Problem sie löst.
+
+## Ziel / Zweck
+
+Kurz das Ziel oder den Bedarf der Software erläutern.  
+(Beispiel: „Diese Software analysiert historische Textdaten, um Netzwerke
+sozialer Interaktionen zu rekonstruieren.“)
+
+## Installation
+
+Kurz und präzise beschreiben, wie die Software installiert wird (max. 3-5
+Schritte).
+
+- Verweise ggf. auf ausführliche `INSTALL.md`
+- **Keine ausführliche Erklärung** von Standard-Tools (z.B. Python
+  installieren), sondern verlinken auf offizielle Seiten
+
+## Nutzung
+
+Minimalbeispiel, wie die Software genutzt wird (kurzer Codeblock oder
+Kommandozeilenaufruf mit typischem Input und Output).
+
+- **Nicht zu komplexe Beispiele**, dafür ggf. auf ausführliches Tutorial
+  (`USAGE.md`) verweisen
+
+## Wissenschaftlicher Hintergrund
+
+Kurze Erklärung der wissenschaftlichen Grundlage (Methode, theoretischer Ansatz)
+und Referenzen auf Publikationen oder Quellen.
+
+- **Keine ausführliche Theorie**, diese gehört in Paper oder eigene Datei
+  (`BACKGROUND.md`)
+
+## Bekannte Einschränkungen
+
+Kurz bekannte Probleme und Limitationen nennen, um Missverständnisse zu
+vermeiden.
+
+- **Keine** ausschweifenden technischen Details, sondern praktische Hinweise.
+
+## Lizenz & Zitation
+
+Kurz auf Lizenz verweisen (z.B. „siehe LICENSE“) und erklären, wie das Projekt
+zu zitieren ist (z.B. DOI oder Verweis auf `CITATION.md`).

example-project/USAGE.md

@@ -0,0 +1,15 @@
+# Nutzung der Software
+
+Ausführliche Beschreibung typischer Workflows oder Beispielanwendungen.
+
+## Beispiele
+
+Detaillierte Schritt-für-Schritt-Anleitungen mit Inputs und Outputs.  
+Evtl. Screenshots oder Abbildungen zur besseren Verständlichkeit.
+
+- **Keine zu detaillierten technischen Details**, Fokus auf realistische
+  Anwendungsfälle.
+
+## FAQs (optional)
+
+Häufig auftretende Fragen zur Nutzung kurz und prägnant beantworten.

example-project/data/sample_data.csv

@@ -0,0 +1,2 @@
+id,value
+1,example

example-project/src/module/helper.py

@@ -0,0 +1 @@
+# Hilfsfunktionen

example-project/src/script.py

@@ -0,0 +1 @@
+# Hauptskript