Files
tsumugu/docs/README.md
T
LarsandCursor 7e39fbb2bd
Deploy Development / deploy (push) Successful in 41s
Test Suite / pytest-backend (push) Failing after 2m55s
Test Suite / smoke-dev (push) Successful in 0s
Test Suite / frontend-build (push) Successful in 23s
Mache große IMAP-Fächer, die Paperless-Suche und die interne Markdown-Notiz über die gemeinsamen Schnittstellen benutzbar.
Co-authored-by: Cursor <cursoragent@cursor.com>
2026-10-20 07:34:14 +02:00

95 lines
7.9 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
# Tsumugu – Dokumentation
Übersicht aller Dokumente im Repository. Verbindlichkeit laut [AGENTS.md](../AGENTS.md): Fachlich führend ist die Produktspezifikation, technisch der Entwurf in `architecture/`. Vorläufige Rechte- und Löschregeln stehen in den MVP-Annahmen.
## Einstieg
| Ich will … | Dokument |
|---|---|
| wissen, was Tsumugu ist und wo es läuft | [../README.md](../README.md) |
| lokal entwickeln und testen | [ENTWICKLUNG_UND_TESTS.md](ENTWICKLUNG_UND_TESTS.md) |
| deployen und Ports nachschlagen | [DEPLOYMENT.md](DEPLOYMENT.md) |
| den fachlichen Stand und offene Entscheidungen kennen | [product/TSUMUGU_PRODUCT_SPEC.md](product/TSUMUGU_PRODUCT_SPEC.md) |
| den aktuellen Qualitätsstand und offene Mängel sehen | [review/README.md](review/README.md) |
## Produkt (`product/`)
| Dokument | Rolle | Stand |
|---|---|---|
| [TSUMUGU_PRODUCT_SPEC.md](product/TSUMUGU_PRODUCT_SPEC.md) | führende Fachspezifikation, alle bestätigten Entscheidungen F-01 bis F-08, S-01 | 0.37 |
| [TSUMUGU_UX_MVP_ERGAENZUNG.md](product/TSUMUGU_UX_MVP_ERGAENZUNG.md) | Bedienung, Orientierung, Abnahmekriterien UX-01 bis UX-21 | 0.8 |
| [TSUMUGU_KOMPAKTE_INHALTSLISTE_AUFTRAG.md](product/TSUMUGU_KOMPAKTE_INHALTSLISTE_AUFTRAG.md) | Auftrag F-06f, hat Vorrang vor älteren Darstellungsvorgaben | 1.0 |
| [TSUMUGU_KOMMUNIKATIONSRICHTUNG_AUFTRAG.md](product/TSUMUGU_KOMMUNIKATIONSRICHTUNG_AUFTRAG.md) | Auftrag F-06e | 1.2 |
| [TSUMUGU_SYMBOLS_LOGOFRAME_AUFTRAG.md](product/TSUMUGU_SYMBOLS_LOGOFRAME_AUFTRAG.md) | Auftrag F-06c, Typ-Symbole und Logo-Rahmen | 17.10.2026 |
| [TSUMUGU_ENSO_ANIMATION_AUFTRAG.md](product/TSUMUGU_ENSO_ANIMATION_AUFTRAG.md) | Einbindung der Ensō-Animation | 17.10.2026 |
| [TSUMUGU_EXPORT_NAECHSTE_LIEFERUNG_2026-10-17.md](product/TSUMUGU_EXPORT_NAECHSTE_LIEFERUNG_2026-10-17.md) | Auftrag F-07a–c, Übergabepaket | 17.10.2026 |
| [TSUMUGU_EXPORT_PRUEFBERICHT_2026-10-17.md](product/TSUMUGU_EXPORT_PRUEFBERICHT_2026-10-17.md) | Prüfbericht der Exportlieferung | 17.10.2026 |
| [TSUMUGU_UNTERKAPITEL_AUFTRAG_2026-10-17.md](product/TSUMUGU_UNTERKAPITEL_AUFTRAG_2026-10-17.md) | Auftrag F-08a | 17.10.2026 |
| [TSUMUGU_UNTERKAPITEL_PRUEFBERICHT_2026-10-17.md](product/TSUMUGU_UNTERKAPITEL_PRUEFBERICHT_2026-10-17.md) | Prüfbericht Unterkapitel | 17.10.2026 |
| [TSUMUGU_CONNECTOREN_BEFUND_2026-10-17.md](product/TSUMUGU_CONNECTOREN_BEFUND_2026-10-17.md) | Bestandsanalyse Paperless/IMAP, Umbauschätzung | 17.10.2026 |
| [TSUMUGU_CONNECTOR_UMBAU_AUFTRAG_2026-10-19.md](product/TSUMUGU_CONNECTOR_UMBAU_AUFTRAG_2026-10-19.md) | begrenzter Umsetzungsauftrag, Abschnitt A beauftragt, Abschnitt B der nächste Ausbau | 19.10.2026 |
| [TSUMUGU_CONNECTOR_ABSCHLUSSKRITERIEN_2026-10-19.md](product/TSUMUGU_CONNECTOR_ABSCHLUSSKRITERIEN_2026-10-19.md) | Abschlusskriterien der Kapselung; Vorrang vor einem teilweise integrierten Zwischenstand | 19.10.2026 |
| [TSUMUGU_CONNECTOR_ABSCHLUSSMATRIX_2026-10-19.md](product/TSUMUGU_CONNECTOR_ABSCHLUSSMATRIX_2026-10-19.md) | Kriterium, Nachweis und Ergebnis der Kapselung | 19.10.2026 |
| [TSUMUGU_CONNECTOR_NACHARBEIT_IMAP_PAPERLESS_MARKDOWN_AUFTRAG_2026-10-19.md](product/TSUMUGU_CONNECTOR_NACHARBEIT_IMAP_PAPERLESS_MARKDOWN_AUFTRAG_2026-10-19.md) | Nacharbeit: IMAP-Seiten, Paperless-Suche, Markdown-Notiz | 19.10.2026 |
| [TSUMUGU_CONNECTOR_BASIS_ERGEBNIS_2026-10-19.md](product/TSUMUGU_CONNECTOR_BASIS_ERGEBNIS_2026-10-19.md) | früherer Zwischenstand von Abschnitt A vor den Abschlusskriterien | 19.10.2026 |
| [TSUMUGU_WEITERPLANUNG_UEBERGABE_2026-10-17.md](product/TSUMUGU_WEITERPLANUNG_UEBERGABE_2026-10-17.md) | Einstieg für die fachliche Weiterplanung | 17.10.2026 |
| [TECHNICAL_SPEC_HANDOFF.md](product/TECHNICAL_SPEC_HANDOFF.md) | historischer Auftrag zur technischen Spezifikation | 16.10.2026 |
| [Tsumugu_Product_Recovery_Baseline_v0.1.md](product/Tsumugu_Product_Recovery_Baseline_v0.1.md) | unveränderte historische Ausgangsbasis | 0.1 |
## Architektur (`architecture/`)
| Dokument | Rolle | Stand |
|---|---|---|
| [TSUMUGU_TECHNICAL_SPEC.md](architecture/TSUMUGU_TECHNICAL_SPEC.md) | technischer Entwurf (Soll): Pakete, Datenmodell, Rechte, API, Nachweise | 0.3 mit Ergänzungen |
| [API_REFERENZ.md](architecture/API_REFERENZ.md) | tatsächlich registrierte Endpunkte (Ist) | 19.10.2026 |
| [DATENMODELL_IST.md](architecture/DATENMODELL_IST.md) | Schema nach allen Migrationen (Ist) | 19.10.2026 |
| [RECHTEMODELL_IST.md](architecture/RECHTEMODELL_IST.md) | implementierte Rechteauswertung (Ist) | 19.10.2026 |
| [ARCHITECTURE_DISCOVERY.md](architecture/ARCHITECTURE_DISCOVERY.md) | Ist-Aufnahme der Jinkendo-Familie vor Tsumugu, keine Beschlüsse | 15.10.2026 |
| [TSUMUGU_CONNECTOR_STORAGE_VERTRAG_v0.1_2026-10-19.md](architecture/TSUMUGU_CONNECTOR_STORAGE_VERTRAG_v0.1_2026-10-19.md) | Umsetzungsvorschlag Source- und Storage-Vertrag | 19.10.2026 |
| [Tsumugu_Connector_Suite_Architektur_v0.2.md](architecture/Tsumugu_Connector_Suite_Architektur_v0.2.md) | Zielarchitektur der Connector Suite, keine pauschale Beschlussübernahme | 19.10.2026 |
| [TSUMUGU_STORAGE_SCHLUESSEL_PRUEFAUFTRAG_2026-10-19.md](architecture/TSUMUGU_STORAGE_SCHLUESSEL_PRUEFAUFTRAG_2026-10-19.md) | vorbereiteter Prüfauftrag an die Architektur-Session, nicht versandt | 19.10.2026 |
## Design (`design/`)
| Dokument | Rolle | Stand |
|---|---|---|
| [LIEFERUNG_2026-10-17.md](design/LIEFERUNG_2026-10-17.md) | Lieferbericht der Arbeitsfläche, bewusste Abweichungen | 17.10.2026, historisch |
Das ausgewählte Designkonzept und die Assetpakete liegen außerhalb des Repositorys unter `C:/Dev/jinkendo-app-design-2026-10-17/`. Die übernommenen Assets stehen in `frontend/public/brand/` und `frontend/public/ui/`.
## Referenz (`reference/`)
Familienweite Vorgaben der Jinkendo-Anwendungen. Verbindliche Verträge und anpassbare Defaults sind dort jeweils getrennt.
| Dokument | Geltung für Tsumugu |
|---|---|
| [A – Technische Referenzarchitektur v0.3](reference/jinkendo-phase3-2-technical-reference-architecture-v0.3-2026-10-16/A_Jinkendo_Technical_Reference_Architecture.md) | verbindlich |
| [B – Implementation Blueprint Foundation v0.3](reference/jinkendo-phase3-2-technical-reference-architecture-v0.3-2026-10-16/B_Implementation_Blueprint_Application_Foundation.md) | verbindlich |
| [C – Technische Entscheidungen v0.3](reference/jinkendo-phase3-2-technical-reference-architecture-v0.3-2026-10-16/C_Technical_Decisions_Open_Issues.md) | verbindlich |
| [Auth, Session & Scope](reference/Jinkendo_Auth_Session_Scope_Blueprint.md) | verbindlich |
| [Medien, Dateien & sicheres Rendering](reference/Jinkendo_Media_Files_Safe_Rendering_Blueprint.md) | verbindlich |
| [Release, Betrieb & Recovery](reference/Jinkendo_Release_Betrieb_Recovery_Blueprint.md) | verbindlich vor echtem Betrieb (Paket P7) |
| [KI-Gateway](reference/Jinkendo_AI_Gateway_Provider_Privacy_Blueprint.md), [Prompt/Workflow](reference/Jinkendo_Prompt_Placeholder_Workflow_Blueprint.md), [Entitlements](reference/Jinkendo_Entitlements_Usage_Quotas_Blueprint.md) | nur als Grenze; keine MVP-Pflicht |
Die Links innerhalb der Referenzdokumente zeigen auf die ursprünglichen Ablageorte unter `C:/Dev/…` und funktionieren im Repository nicht.
## Betrieb und Regeln
| Dokument | Rolle |
|---|---|
| [DEPLOYMENT.md](DEPLOYMENT.md) | Umgebungen, Ports, Workflows, Proxy, bekannte Betriebsgrenzen |
| [MVP_ANNAHMEN.md](MVP_ANNAHMEN.md) | vorläufige Rechte- und Löschregeln, Cookie-Abweichung in Development |
| [ENTWICKLUNG_UND_TESTS.md](ENTWICKLUNG_UND_TESTS.md) | Konfiguration, lokaler Start, Tests, neue Migration und Route |
## Review (`review/`)
| Dokument | Inhalt |
|---|---|
| [review/README.md](review/README.md) | Code-Review vom 18.10.2026: Gesamtbewertung, Anforderungsabdeckung, Befunde, Maßnahmenplan |
## Pflege
- Neue Fachentscheidung → Produktspezifikation (Abschnitt 5 und Fortschreibung).
- Neue Route, Migration oder Rechteregel → die passende Ist-Datei in `architecture/` im selben Commit.
- Neuer Auftrag oder Prüfbericht → `product/`, hier in der Tabelle eintragen.