Diese Dokumentation bildet alle Funktionen der Software zentral ab und ist für die spätere Nutzung auf einer eigenen Docs-Homepage vorbereitet, z. B. mit Nuxt Content oder Docusaurus.

Ziel

Vollständige Übersicht über Funktionen in Backend, Web-Frontend und Mobile-App
Nachvollziehbare Versionierung der Doku
Einfache Aktualisierung bei Funktionsänderungen

Struktur

docs/funktionen/uebersicht.md: Fachliche Gesamtübersicht der Bereiche
docs/funktionen/backend-api.md: Automatisch erzeugte API-Funktionsliste
docs/funktionen/frontend-web.md: Automatisch erzeugte Seiten-/Funktionsliste des Web-Frontends
docs/funktionen/mobile-app.md: Automatisch erzeugte Screens-/Funktionsliste der Mobile-App
docs/versionen/docs-versionen.md: Versionierung der Dokumentation
docs/wartung/dokumentationsprozess.md: Prozess, damit die Doku dauerhaft aktuell bleibt
docs/scripts/sync-funktionsdoku.mjs: Skript zur automatischen Aktualisierung

Aktualisierung bei Funktionsänderungen

Bei jeder Funktionsänderung bitte ausführen:

node docs/scripts/sync-funktionsdoku.mjs

Danach:

Änderungen in docs/funktionen/*.md prüfen
Falls nötig fachliche Texte in docs/funktionen/uebersicht.md ergänzen
Eintrag in docs/versionen/docs-versionen.md ergänzen
Alles gemeinsam committen

Verwendung mit Nuxt Content

Empfohlene Vorgehensweise:

docs/ in das Content-Verzeichnis übernehmen (oder per Sync einbinden)
Navigation anhand der Ordner funktionen, wartung, versionen aufbauen
backend-api.md, frontend-web.md, mobile-app.md als referenzierende Funktionskataloge einbinden

Verwendung mit Docusaurus

Empfohlene Vorgehensweise:

Inhalte aus docs/ in den Docusaurus-docs-Ordner übernehmen
Sidebar nach den Bereichen Funktionen, Wartung, Versionen strukturieren
Die automatisch erzeugten Dateien als technische Referenzseiten markieren

Hinweis

Die Dateien backend-api.md, frontend-web.md und mobile-app.md werden automatisch generiert. Manuelle Änderungen in diesen Dateien werden bei der nächsten Synchronisation überschrieben.