From 243622013f736f647eaeedd817f3c9d281d900ad Mon Sep 17 00:00:00 2001 From: patrick Date: Mon, 19 Oct 2026 03:19:03 +0200 Subject: [PATCH] docs: Root-README als Dokumentenlandkarte, toten Verweis in CLAUDE.md gefixt Fable-5.1-Strukturreview (MD-Dateien) fand: kein Root-README/Index, daher niemand findet die Doku-Ebenen (Root-Konzepte -> 8 Boards -> Modul-docs/ -> docs/). CLAUDE.md verwies auf datenmodell-altsysteme.md, das nirgends im Repo existiert - auf die vorhandenen known-issues-archivdms/archivmail.md umgebogen. Zurueckgestellt bis Nutzerentscheidung (Fable5 hatte dafuer offene Fragen gestellt): docs/ in core/docs umbenennen, dms-kanban-Sonderdateien (reuse-mapping.md, known-issues-*.md) verschieben, docs/cut-01/ auslagern, code*/-Worktrees gitignoren. Co-Authored-By: Claude Sonnet 5 --- CLAUDE.md | 2 +- README.md | 53 +++++++++++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 54 insertions(+), 1 deletion(-) create mode 100644 README.md diff --git a/CLAUDE.md b/CLAUDE.md index ff5c8024..953eed4d 100644 --- a/CLAUDE.md +++ b/CLAUDE.md @@ -4,7 +4,7 @@ Siehe `PRODUKTARCHITEKTUR.md` für die Gesamtübersicht sowie die weiteren Konze ## Datenschutz (DSGVO) -- **Keine echten Kunden-/Mandantendaten in Prompts, Testfixtures oder Screenshots** — je nach Zielsystem (siehe `datenmodell-altsysteme.md`) potenziell personenbezogene oder besondere Kategorien von Daten (Art. 9 DSGVO). +- **Keine echten Kunden-/Mandantendaten in Prompts, Testfixtures oder Screenshots** — je nach Zielsystem (siehe `dms-kanban/known-issues-archivdms.md`, `dms-kanban/known-issues-archivmail.md`) potenziell personenbezogene oder besondere Kategorien von Daten (Art. 9 DSGVO). - Test-/Demodaten synthetisch halten, nie einen Export aus einem echten Kunden-/Altsystem als Fixture verwenden. - Secrets (API-Keys, DB-Credentials, Verschlüsselungs-Keys) nie in Prompts einfügen. - Claude Code hier ausschließlich für Code-/Konzeptarbeit; für Auswertungen an echten Kundendaten (z. B. Migrationstests gegen Altsysteme) lokale Ollama-Server nutzen, nicht Claude. diff --git a/README.md b/README.md new file mode 100644 index 00000000..c81baed1 --- /dev/null +++ b/README.md @@ -0,0 +1,53 @@ +# NEXARCH + +Modulares Dokumentenmanagement- und Office-System. Siehe `CLAUDE.md` für +Arbeitsregeln (Datenschutz, Secrets) und die Konzeptdokumente unten für die +fachliche Gesamtübersicht. + +## Dokumentenlandkarte + +**Root-Ebene — Konzeptdokumente (projektweit):** + +| Datei | Inhalt | +|---|---| +| `PRODUKTARCHITEKTUR.md` | Gesamtübersicht über Module, Schnittstellen, Deployment | +| `SICHERHEITSKONZEPT.md` | Sicherheitsarchitektur, Bedrohungsmodell | +| `MIGRATIONSKONZEPT.md` | Übernahme aus Altsystemen (archivdms, archivmail) | +| `SKALIERUNGSKONZEPT.md` | Mandantenfähigkeit, Skalierungsstrategie | +| `STORAGE-KONZEPT.md` | Speicher-/Ablagearchitektur | +| `SAAS-BETRIEBSMODELL.md` | Betriebsmodell für den SaaS-Betrieb | +| `UI-UX-KONZEPT.md` | Design-System- und UX-Leitlinien | +| `CLAUDE.md` | Arbeitsregeln für KI-gestützte Entwicklung in diesem Repo | + +**Module (je eigenes Kanban-Board + Code-Verzeichnis):** + +| Board | Code | Modul | +|---|---|---| +| `core-kanban/` | `internal/`, `cmd/` | Identität, Mandanten, Rechte, API-Grundgerüst | +| `dms-kanban/` | `dms/` | Dokumentenmanagement (siehe `dms/README.md` für Referenzprojekte) | +| `mail-kanban/` | `mail/` | Postfach-Modul | +| `workflow-kanban/` | `workflow/` | Aufgaben, Freigaben, Routing | +| `ai-kanban/` | `ai/` | KI-Funktionen (Zusammenfassung, Extraktion, Suche) | +| `connect-kanban/` | `connect/` | Externe Systemanbindungen (ERP, DATEV, CRM) | +| `archive-kanban/` | `archive/` | Archivierung, Retention, Kennzahlen | +| `migration-kanban/` | `migrations/` | Datenübernahme aus Altsystemen | + +Jedes Board hat `README.md` (Modulübersicht) und `DEVLOG.md` (Session-Log). +Ticket-Dateien liegen unter `/tickets/.md`, Bearbeitungsstand in +`/board.csv`/`board.json`. + +**Prüfprotokolle:** + +- `docs/` — Core-Prüfprotokolle (`-PRUEFPROTOKOLL.md`) sowie einige + projektweite Betriebsdokumente (Teststrategie, Coding-Guidelines, Incident + Response, Rollout-131) +- `/docs/` (z. B. `dms/docs/`, `ai/docs/`) — Prüfprotokolle des + jeweiligen Moduls + +**Gemeinsames Frontend-Design-System:** `web/shl/` (`@nexarch/shl`), von +allen `web//`-Apps importiert. + +## Setup + +Jedes Modul hat ein eigenes `README.md` mit Setup-Anleitung (z. B. +`dms/README.md`, `cmd/`/`internal/` für Core).