Track HiveGrid Cloud planning reference
This commit is contained in:
1 parent
b3d5ea6764
commit
e341c5938a
5784 files changed
+1104929
-3
No files matched your search
@@ -0,0 +1,87 @@
|
||||
# M173 — Help-Center: Routes + Suche + SEO + Kontextuelle Hilfe
|
||||
|
||||
**Block:** Block 7 · Modul 38
|
||||
**Pflichtenheft-Quelle:** block7.md Abschnitte 38.1.6-38.1.13
|
||||
|
||||
## Ziel
|
||||
Routes: `/help/` (Sprach-Redirect), `/help/de/` (Home mit Kategorien + Suche), `/help/de/<kategorie>/`, `/help/de/<kategorie>/<slug>`, `/help/de/search?q=...`, `/help/sitemap.xml`. Öffentlich, kein Login. SEO: statisches Rendering, Cache-Header, Title/Description aus Frontmatter, Open-Graph, Canonical. Suche: Title-Match zuerst, dann Description, Keywords, Body. Treffer-Snippet mit Highlight. Empty-State mit support@hivegrid.de-Link. Artikel-Detail mit TOC aus H2, verwandten Artikeln, „War hilfreich?"-Feedback (Daumen, anonym). Veraltet-Banner. Kontextuelle Hilfe: Hilfe-Icon in App-Bereichen mit Tiefenroute-Mapping.
|
||||
|
||||
## Pflichtenheft-Bezug
|
||||
- 38.1.6 — Routes
|
||||
- 38.1.7-38.1.13 — Public + SEO + Suche + Detail + Veraltet
|
||||
- 38.2.3 — Performance: Client-side FlexSearch ODER Server-Postgres-FTS
|
||||
|
||||
## Abhängigkeiten
|
||||
- **Vorbedingung:** M172
|
||||
- **Wird benötigt von:** Mandanten-Workflow + Support-Reduktion
|
||||
|
||||
## Out of Scope
|
||||
- Mehrsprachigkeit → Phase 2 (38.X.2)
|
||||
- Inline-Side-Panel-Hilfe → Phase 2 (38.X.6)
|
||||
- Video-Tutorials → Phase 2 (38.X.7)
|
||||
|
||||
## Erfolgskriterium
|
||||
Externer Browser öffnet `/help/de/integrationen/kwp-setup` ohne Login; Suche „KWP" liefert Treffer mit Highlight in <500ms; In-App-Hilfe-Icon im KWP-Bereich öffnet richtigen Artikel.
|
||||
|
||||
## Hinweise für Slice-Planung
|
||||
- FlexSearch ~50KB für 20 Artikel (Phase-1-Größe)
|
||||
- TOC-Generator aus H2-Headers
|
||||
|
||||
|
||||
---
|
||||
|
||||
## 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.ts` mit 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 `logActivity` bei 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-mock` aus 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:
|
||||
|
||||
1. Login als geeigneter User-Typ (siehe Erfolgskriterium oben)
|
||||
2. Sidebar-Gruppe + Eintrag öffnen (gemäß INTEGRATION-CONTRACTS.md §1)
|
||||
3. Hauptaktion ausführen
|
||||
4. Erwartetes Ergebnis sichtbar (siehe Erfolgskriterium)
|
||||
|
||||
**Falls etwas nicht erreichbar ist:** Milestone ist trotz „grüner Tests" nicht fertig — siehe Erreichbarkeits-Checkliste oben.
|
||||
|
||||
Reference in new issue
Block a user