start

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