Files
HiveGrid-Wireframes/hivegrid-cloud/docs/milestones/M175-help-desk-self-service/PLAN.md
T

81 lines
3.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.
# M175 — Help-Desk: In-App-Feedback-Widget („Problem melden")
**Block:** Block 7 · Modul 39
**Pflichtenheft-Quelle:** block7.md Abschnitt 39.1
## Ziel
„Problem melden"-Trigger global erreichbar in jeder Mandanten-Route. Im Help-Center identischer Trigger via mailto:support@hivegrid.de. Eingabe-Modal mit Klartext-Hinweis, aktueller Route-Anzeige, DSGVO-Hinweis, mehrzeiligem Pflichtfeld (≥10 Zeichen), Anhang-Upload (max 5 × 10MB, PNG/JPG/WEBP/PDF), „Screenshot anhängen"-Funktion (One-Click optional). Auto-Erfasst: Mandant, User, Route ohne sensible Query-Params, Browser-Info (UA/Viewport/Sprache/Timezone), App-Version, Zeitstempel. Klartext-Erfolg/-Fehler. Rate-Limit: 10/User/h, max 10K Zeichen Body. Jeder eingeloggte User kann melden (kein Premium).
## Pflichtenheft-Bezug
- 39.1 — alle Punkte
## Abhängigkeiten
- **Vorbedingung:** M174 (Backend), M015 (UI), M052 (Anhang-Upload)
- **Wird benötigt von:** Mandanten-Self-Service
## Erfolgskriterium
Jeder Mandanten-User klickt „Problem melden" → Modal öffnet → Submit erfolgreich; Rate-Limit blockiert 11. Submission/h mit Klartext (39.Y.4); Public-Help-Center hat mailto-Link.
## Hinweise für Slice-Planung
- Screenshot-API via html2canvas-pro (Boilerplate-Deps)
- Browser-Info-Sammler als Util
---
## 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.