5.9 KiB
5.9 KiB
08 – Vollständigkeit der Dokumentation
1. Bestand vor dem Review
| Dokument | Zustand | Befund |
|---|---|---|
README.md |
veraltet | Behauptete, Development lege Beispieldaten an und die Anmeldeseite zeige Ada und Ben. Der Code entfernt Fixture-Konten in jeder Umgebung; die Beispielkonten erscheinen nur bei *_test mit SEED_DEMO=true. Spätere Lieferungen (Quellen, Export, Unterkapitel) fehlten im Stand. Kein Verweis auf weitere Dokumente |
AGENTS.md |
aktuell | – |
docs/DEPLOYMENT.md |
weitgehend aktuell | Kein Hinweis auf fehlende Sicherung, Web-Bootstrap des Betreibers, gemeinsame DB-Passwörter, Klartext-Secrets der Quellen |
docs/MVP_ANNAHMEN.md |
aktuell | Löschen ganzer Behälter durch Bearbeiter ist nicht abgedeckt (Code-Abweichung, R-01) |
product/TSUMUGU_PRODUCT_SPEC.md |
aktuell (0.37) | Historische Etappensätze („keine Implementierung“) sind als solche markiert. Nicht beschrieben: Aufgabenabhängigkeiten, Aufgaben-Inhaltsverknüpfung, Vorgang verschieben, Behälter löschen (R-17) |
product/TSUMUGU_UX_MVP_ERGAENZUNG.md |
aktuell (0.8) | – |
product/TSUMUGU_WEITERPLANUNG_UEBERGABE_2026-10-17.md |
leicht veraltet | nennt die Produktspezifikation „aktuell 0.34“ |
architecture/TSUMUGU_TECHNICAL_SPEC.md |
teilweise veraltet | Kopf „Stand 16.10.2026, Fassung 0.3“, enthält aber Ergänzungen bis F-08a. Abschnitt 1.3 sagt, es gebe keine Fachanwendung; Abschnitt 8 empfiehlt „nur P0“ als ersten Auftrag. Das API-Verzeichnis 6.2 hat 39 Zeilen (teils mit mehreren Pfaden, teils Ausbauentwurf); registriert sind 105 Routen. Nicht beschrieben: Connectoren, Export-API, Bezüge, Aufgabenabhängigkeiten, Kontoanlage durch Betreiber, Web-Bootstrap, Sessionlaufzeit |
architecture/ARCHITECTURE_DISCOVERY.md |
historisch | ausdrücklich keine Beschlüsse; in Ordnung |
design/LIEFERUNG_2026-10-17.md |
historisch, teils überholt | „Ein Service Worker ist bewusst nicht enthalten“: inzwischen registriert (public/sw.js, Commit db40632). Drag-and-drop „nicht ausgeführt“: ein späterer Nachweis fehlt |
docs/design/ |
unvollständig | Das ausgewählte Designkonzept (JINKENDO_APP_DESIGN_CONCEPT.md, Umsetzungsauftrag, Assetpakete) liegt nur außerhalb des Repositorys. Für Leser des Repositorys ist die Gestaltungsgrundlage nicht nachvollziehbar |
docs/reference/ |
vorhanden, aber nicht versioniert | Der Ordner ist ungetrackt; ohne Commit fehlt er in jedem anderen Checkout. Interne Links zeigen auf C:/Dev/… außerhalb des Repositorys |
Fehlende Dokumentarten vor dem Review
| Dokumentart | Bedarf |
|---|---|
| Dokumentationsindex | Orientierung über knapp 30 Dokumente mit unterschiedlicher Verbindlichkeit |
| API-Referenz des Ist-Stands | OpenAPI ist abgeschaltet; es gab keine vollständige Endpunktliste |
| Ist-Datenmodell | Schema nur aus elf Migrationen rekonstruierbar |
| Ist-Rechteauswertung | Kern der Fachlichkeit, nur im Code nachvollziehbar |
| Entwicklung und Tests | keine Anleitung für lokalen Start, Konfiguration und Testdatenbank |
| Betriebshandbuch Sicherung/Wiederherstellung | fehlt, weil P7 fehlt; muss mit P7 entstehen |
| Änderungsprotokoll / Lieferstand | Stand nur über Commits und Prüfberichte rekonstruierbar |
| Abweichungsregister (begründete Default-Anpassungen nach A0) | A0 verlangt eine kurze Begründung je angepasstem Default (Sessionlaufzeit, Frontend-Versionen, Upload-Verfahren). Es gibt keine solche Stelle |
2. Im Review ergänzt oder korrigiert
| Datei | Art | Inhalt |
|---|---|---|
docs/README.md |
neu | Dokumentationslandkarte mit Rolle, Stand und Verbindlichkeit |
docs/architecture/API_REFERENZ.md |
neu | alle registrierten Endpunkte mit Zweck und Rechten |
docs/architecture/DATENMODELL_IST.md |
neu | alle Tabellen, Regeln, Beziehungsdiagramm, bewusst fehlende Tabellen |
docs/architecture/RECHTEMODELL_IST.md |
neu | Auswertung je Objektart, schreibende Aktionen, Sichtbarkeit, bekannte Abweichungen |
docs/ENTWICKLUNG_UND_TESTS.md |
neu | Konfiguration, lokaler Start, Tests, Vorgehen bei Migration und Route |
docs/review/* |
neu | dieser Bericht |
README.md |
korrigiert | Beispieldaten richtiggestellt, Stand ergänzt, Verweise auf Dokumentation und Review |
docs/DEPLOYMENT.md |
ergänzt | Abschnitt „Bekannte Betriebsgrenzen“ |
docs/architecture/TSUMUGU_TECHNICAL_SPEC.md |
ergänzt | Hinweis zum Ist-Stand am Anfang; der Inhalt der Spezifikation bleibt unverändert |
Fachspezifikation, UX-Ergänzung, Aufträge, Prüfberichte und historische Dokumente wurden nicht verändert. Ihre Aussagen sind Entscheidungs- bzw. Lieferstände und sollen als solche erhalten bleiben.
3. Verbleibende Lücken
| Lücke | Empfehlung | Verantwortung |
|---|---|---|
| Fachpunkte für Mehrumfang (R-17) | in der Produktspezifikation nachtragen oder Funktionen bestätigen | Produkt |
| Technische Spezifikation 0.4 | Abschnitt 1.3 und 8 auf den Ist-Stand bringen; API-Verzeichnis auf API_REFERENZ.md verweisen; Abweichungen (Session, Upload, Connectoren, Bootstrap) entweder beheben oder als begründete Default-Anpassung eintragen |
Technik |
| Abweichungsregister nach A0 | kurze Tabelle „Default, gewählter Wert, Grund, Nachweis“ in der technischen Spezifikation | Technik |
| Referenzarchitektur und Blueprints versionieren | docs/reference/ committen, damit Verweise aus docs/README.md und diesem Review in jedem Checkout auflösen |
Technik |
| Designgrundlage im Repository | Designkonzept und Umsetzungsauftrag nach docs/design/ kopieren oder dauerhaft verlinken |
Design |
| Betriebshandbuch Backup/Restore | mit Paket P7 erstellen | Betrieb |
| Lieferstand / Änderungsprotokoll | docs/CHANGELOG.md mit Lieferungen und geprüftem Commit je Lieferung |
Technik |
| Prüfbericht zu UX-17 | echten Drag-and-drop-Nachweis mit acht Einträgen dokumentieren | Technik |
| Pflege der Ist-Dokumente | bei jeder Route/Migration im selben Commit nachziehen (Regel in docs/README.md) |
alle |