4.0 KiB
M002 — Klartext-Diagnostik
Block: Querschnitt-Hülle Teil 1 (Bauprinzipien)
Bauprinzip: A.1 — Klartext-Diagnostik in jedem Feature
Pflichtenheft-Quelle: _bmad-output/pflichtenheft/03-architektur.md Sektion A.1
Ziel
Jeder erkennbare Fehler-Zustand in HiveGrid hat einen vorformulierten Klartext-Text und (wo sinnvoll) einen Lösungs-Knopf — kein nackter HTTP-Code, kein kryptisches Log.
Pflichtenheft-Bezug
- A.1.1 — Fester Klartext-Text + optional Lösungs-Knopf pro Fehler-Zustand
- A.1.2 — Keine KI-on-the-fly-Übersetzung in Phase 1; Texte sind redaktionell vorgefertigt
- A.1.3 — Kein Feature-Release ohne definierte Klartext-Texte
Abhängigkeiten
- Wird benötigt von: allen folgenden Modulen
- Hängt zusammen mit: M003 (i18n), weil Klartext mehrsprach-fähig sein muss
Out of Scope
- KI-Live-Übersetzung von Fehlern (Phase 2)
- Auto-Generierung von Texten
Erfolgskriterium
Geworfener Catalog-Fehler erscheint als deutscher Klartext-Hinweis im UI mit korrektem Lösungs-Knopf-Verhalten; ESLint-Rule lehnt nackte throw new Error("...") außerhalb des Catalogs ab.
Hinweise für Slice-Planung
- Catalog-Format als TypeScript-Modul + i18n-Keys
- Error-Boundary (RR7-kompatibel)
- Logger-Bridge zu Pino
- Migrations-Lint für bestehende Boilerplate-Fehler
- Klartext-Beispiele aus Pflichtenheft-Modulen übernehmen (z.B. M27.15)
Definition of Done — verbindlich (siehe AGENTS.md + docs/INTEGRATION-CONTRACTS.md)
Dieses Milestone gilt nur dann als erledigt, wenn alle Punkte wahr sind. Bei Verstoß: PR-Block.
Erreichbarkeit
- Sidebar-Eintrag in
packages/ui-hivegrid/src/app-shell/sidebar.config.tsmit Permission-Gate (oder explizit dokumentiert, warum nur Inline-Verlinkung) — Gruppe gemäßdocs/INTEGRATION-CONTRACTS.md§1 - Route unter korrektem URL-Pattern (INTEGRATION-CONTRACTS §3)
- Breadcrumb für Detail-Routes (§4)
- Mobile-Tab-Bar-Eintrag falls mobile-relevant (§13)
- Customer-Portal-Sichtbarkeit explizit konfiguriert (§14)
Querschnitt-Wiring
- Audit läuft (auto via M001 oder manuell)
- Activity-Stream via
logActivitybei relevanter Aktion (M045) - Notifications via
notify()(M011), nicht direkt - Search-Index registriert in
indexed-entities.ts, falls suchbar - Permission-Filter via
withTenantScope()+withPermission()(M004) - Feature-Flag-fähig (M006) — Modul ohne Deploy abschaltbar
Code-Layer-Disziplin (PR-Block)
- Loader baut View-Model; UI-Component empfängt nur VM + Actions
- Keine Prisma-/Server-Imports in
packages/ui-hivegrid/** - Subframe-Output via Adapter, nicht direkt importiert
- Alle UI-Texte als i18n-Keys (M003-Build-Lint blockt sonst)
Tests
- Unit-Test für VM-Builder mit Zod-Schema-Validierung
- Smoke-Test
e2e/smoke/<modul>.spec.ts(Login → Route → Hauptaktion → erwartetes UI) - Hot-Swap-Drill grün (Smoke-Test gegen
packages/ui-mockaus M017) - Visual-Regression-Snapshot der Hauptansicht (M016)
Klartext (User-facing)
- Fehler-Texte aus M002-Catalog (kein HTTP-Code im UI)
- Empty-State mit Klartext + nächster Aktion
- Loading-State mit Klartext (kein leerer Spinner)
- Permission-Denied → 404, nicht 403 (Bauprinzip A.5.3)
Rollback-Pfad
- Forward-Only-DB-Migration mit Inverse-SQL als Kommentar
- Atomic-Slice-Commits (TC-Default)
- Feature-Flag vorhanden, um das Modul ohne Deploy auszuschalten
Klick-Pfad zum Prüfen (für User)
Wenn dieses Milestone fertig ist, prüft der User die Funktion über folgenden Pfad:
- Login als geeigneter User-Typ (siehe Erfolgskriterium oben)
- Sidebar-Gruppe + Eintrag öffnen (gemäß INTEGRATION-CONTRACTS.md §1)
- Hauptaktion ausführen
- Erwartetes Ergebnis sichtbar (siehe Erfolgskriterium)
Falls etwas nicht erreichbar ist: Milestone ist trotz „grüner Tests" nicht fertig — siehe Erreichbarkeits-Checkliste oben.