Zum Inhalt

DiveLogix360 – Standard für Use-Case-Dossiers

Stand: 12.08.2026 16:55 Branch: main Status: Aktiv

Datum, Uhrzeit Version Änderung Autor
12.08.2026 16:55 1.3 Dossier-Rollout abgeschlossen und strikten Prüfmodus verbindlich gesetzt Codex
07.08.2026 18:38 1.2 Schweizer Schreibweise in verbindlichen Begriffen bereinigt Codex
07.08.2026 17:44 1.1 Verbindliche Abschlusscheckliste, Abnahmeregeln und automatisierte Nachweiskontrolle ergänzt Codex
07.08.2026 17:30 1.0 Verbindlichen Aufbau, Terminologie und Pflegeprozess für Use-Case-Dossiers eingeführt Codex

Verbindlichkeit: Dieses Dokument definiert die einheitliche Einstiegs- und Navigationsstruktur für alle Use Cases (UCs).
Prinzip: Ein Dossier ist der zentrale Einstiegspunkt, nicht der alleinige physische Ablageort.

Ziel und Geltungsbereich

Jeder Use Case erhält in seinem Ordner eine README.md. Sie führt alle fachlichen und technischen Artefakte des Use Cases zusammen, ohne bestehende Inhalte zu kopieren oder ihre fachlich sinnvolle Ablage zu verändern. Der Standard gilt für UC00 bis UC09, UC-SA und UC18 sowie für künftig ergänzte Use Cases.

Verbindliche Kapitelstruktur

Alle Dossiers verwenden exakt diese Überschriften, diesen Wortlaut und diese Reihenfolge:

  1. Überblick
  2. Fachliche Dokumentation
  3. Benutzerabläufe und Oberflächen
  4. Datenmodell
  5. Programmierschnittstellen
  6. Architekturentscheidungen
  7. Datenschutz und Compliance
  8. Implementierung
  9. Tests und Abnahme
  10. Offene Punkte

Die Kapitel dürfen nicht entfernt, umbenannt oder umsortiert werden. Gibt es zu einem Kapitel noch kein Artefakt, wird dies mit dem Status Offen dokumentiert. Ist ein Kapitel fachlich nicht relevant, wird Nicht anwendbar verwendet und begründet.

Einheitliche Tabellenstruktur

Die Kapitel 2 bis 10 führen Artefakte mit denselben Spalten:

Artefakt Status Verbindlichkeit Ablageort Hinweis
Beispiel Vorhanden Verbindlich pfad/zum/dokument.md Kurze Einordnung

Unter Ablageort wird der kanonische Repository-Pfad angegeben. Existiert das Artefakt noch nicht, wird der geplante Pfad genannt und nicht verlinkt.

Einheitliche Statuswerte

Status Bedeutung
Vorhanden Das Artefakt existiert und ist für seinen beschriebenen Zweck verwendbar.
Teilweise vorhanden Das Artefakt existiert, enthält aber noch erkennbare Lücken.
Offen Das Artefakt fehlt oder wurde noch nicht begonnen.
Zur Prüfung Das Artefakt liegt vor, benötigt aber noch fachliche oder technische Freigabe.
Historisch Das Artefakt dokumentiert einen früheren Stand und ist nicht mehr führend.
Nicht anwendbar Das Kapitel oder Artefakt ist für diesen Use Case begründet nicht relevant.

Einheitliche Verbindlichkeitswerte

Verbindlichkeit Bedeutung
Verbindlich Freigegebene fachliche oder organisatorische Vorgabe.
Technische Wahrheit Massgebliche technische Definition des aktuellen Systems.
Abgeleitet Zusammenfassung oder Sicht auf eine führende Quelle.
Prüfnachweis Review, Abgleich oder Testergebnis mit Nachweischarakter.
Geplant Vorgesehene, aber noch nicht erstellte oder freigegebene Quelle.
Historisch Nicht mehr führende Quelle eines früheren Stands.

Kanonische Ablage und Verantwortlichkeit

Informationsart Führende Quelle
Fachliche Regeln und Akzeptanzkriterien Use-Case-Spezifikation im jeweiligen UC-Ordner
Datenbankschema backend/prisma/schema.prisma
Vertiefte Schema-Prüfung docs/developer/database/schema-abgleich/
Programmierschnittstellen OpenAPI-Dokumente unter docs/api/
Architekturentscheidung Einzeldatei und Register unter docs/developer/adr/
Umsetzungsfortschritt und Aufgaben docs/management/project-status.md
Review-Ergebnisse Jeweiliger Review-Ablageort als Prüfnachweis

Das Dossier verlinkt diese Quellen und ordnet sie ein. Es ersetzt sie nicht. Widersprüche werden im Kapitel Offene Punkte benannt und an der führenden Quelle behoben.

Kopfbereich und Änderungshistorie

Jedes Dossier und jede zentrale Dossier-Dokumentation enthält:

  • Stand mit Datum und Uhrzeit;
  • Branch;
  • Status;
  • eine chronologisch absteigende Änderungshistorie mit Datum, Version, Änderung und Autor.

Bei jeder inhaltlichen Änderung werden Stand, Version und Änderungshistorie in derselben Änderung nachgeführt. Abkürzungen werden bei der ersten Verwendung ausgeschrieben.

Verbindliche Abschlusscheckliste

Jeder Use Case erhält zusätzlich eine Datei <uc>-abschlusscheckliste.md. Sie bildet die zehn Dossier-Kapitel als Abnahme-Gates ab und verwendet stabile Kriterien-IDs nach dem Muster UCXX-01-01 bis UCXX-10-NN.

Zulässige Kriterienstatus sind Offen, In Bearbeitung, Blockiert, Zur Prüfung, Erledigt und Nicht anwendbar. Ein Kriterium darf nur mit verlinktem oder eindeutig bezeichnetem Nachweis als Erledigt gelten. Nicht anwendbar erfordert ebenfalls eine dokumentierte Begründung.

Der Projektstatus bleibt die führende Quelle für Aufgaben, Prioritäten und Bearbeitungsfortschritt. Die Abschlusscheckliste ist die führende Quelle für die Abnahmereife. Das Dossier zeigt den zusammengefassten Stand und verlinkt beide Quellen.

Der fachliche Status Abgeschlossen setzt die Erledigung aller fachlichen Pflichtkriterien voraus. Der Status Produktionsbereit setzt die Erledigung aller Pflichtkriterien voraus. Begründet nicht anwendbare Kriterien gelten dabei als abgeschlossen.

Einführungs- und Pflegeprozess

  1. Bestehende Artefakte inventarisieren.
  2. Dossier aus der verbindlichen Vorlage erstellen.
  3. Kanonische Quellen verlinken und ihren Status einordnen.
  4. Abschlusscheckliste mit stabilen Kriterien-IDs erstellen.
  5. Lücken als offene Punkte erfassen.
  6. Umsetzungs- und Testaufgaben im Projektstatus ergänzen.
  7. Dossier und betroffene Quellen einschliesslich Änderungshistorien aktualisieren.
  8. Struktur- und Abschlusschecklistenprüfung ausführen.
  9. Änderungen gemeinsam veröffentlichen.

Die Einführung wurde mit UC00 als Pilot begonnen und für UC01 bis UC09, UC-SA und UC18 abgeschlossen. Alle Use Cases werden im Dokumentationsindex über ihr Dossier erschlossen. Inhaltliche Lücken und widersprüchliche Artefaktstatus bleiben in Dossier, Inventar und Abschlusscheckliste ausdrücklich offen.

Automatisierte Prüfung

Das Skript tools/validate-uc-dossiers.ps1 prüft Struktur, Kopfbereich, lokale Verweise sowie vorhandene Abschlusschecklisten auf eindeutige IDs, erlaubte Statuswerte und Nachweise für erledigte Kriterien. Fehlende Dossiers und Abschlusschecklisten sind nach Abschluss des Rollouts Fehler. Das Skript ist deshalb verbindlich mit -Strict auszuführen. Die Strukturprüfung bestätigt nicht die Fachlichkeit, Implementierung oder Produktionsreife.