Files
HiveGrid-Wireframes/hivegrid-cloud/docs/milestones/M159-onboarding-branchen-templates/PLAN.md
T

3.9 KiB

M159 — Onboarding: Branchen-Templates deklarativ (A.3)

Block: Block 7 · Modul 29 + Bauprinzip A.3 Pflichtenheft-Quelle: block7.md Abschnitt 29.3, 03-architektur.md A.3

Ziel

Branchen-Templates als Verzeichnis-Struktur mit YAML-Dateien pro Branche (Pipelines, Rollen, Form-Templates, Custom-Felder, Beispieldaten, Erste-Schritte-Checkliste). Phase 1: nur SHK aktiv, andere („Elektro", „Maler", „Sanitär", „Tischlerei", „Dachdecker") als „Coming soon". Templates beim System-Start eingelesen. Geseedete Inhalte sind nach Setup voll editierbar (kein Locked Template). Eine neue Branche aufzunehmen = einen neuen Ordner mit Templates anlegen, KEIN Code-Patch.

Pflichtenheft-Bezug

  • 29.3 — alle Punkte
  • A.3 — Branchen-Templates deklarativ

Abhängigkeiten

  • Vorbedingung: M157, M158
  • Wird benötigt von: Phase-2-Branchen-Erweiterung

Out of Scope

  • Andere Branchen aktiv → Phase 2 (29.X.1)
  • Multi-Branchen-Mandant → Phase 2 (29.X.6)

Erfolgskriterium

Test: neue YAML-Datei für Branche „Elektro" + Server-Restart → Branche im Wizard wählbar — KEINE Code-Änderung.

Hinweise für Slice-Planung

  • Verzeichnis-Struktur: branches/<branche>/{pipelines,rollen,forms,custom-fields,beispieldaten,erste-schritte}.yaml
  • Build-Validierung pro Template

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.