Files
HiveGrid-Wireframes/hivegrid-cloud/docs/milestones/M172-help-center-artikel-mgmt/PLAN.md
T

3.9 KiB

M172 — Help-Center: Markdown-Artikel-Mgmt (Git-PRs)

Block: Block 7 · Modul 38 Pflichtenheft-Quelle: block7.md Abschnitt 38.1

Ziel

Phase 1: Inhalte als Markdown-Files im Repository, Pflege via Git-PRs durch Plattform-Team (KEIN Editor-UI). Verzeichnis-Struktur content/help/de/<kategorie>/<slug>.md mit Pflicht-Frontmatter (slug, title, kategorie, sort, description, last_updated; optional related, keywords, deprecated, redirect). Markdown mit H2-H4, Listen, Tabellen, Code-Blöcken, Hinweis-Blocks. Build-Schritt erzeugt Volltext-Index + Kategorien-Manifest + Sitemap. Build-Validierung: alle Kategorie-Refs + Verlinkungen.

Pflichtenheft-Bezug

  • 38.1.1-38.1.5 — Markdown-Pflege + Build-Validierung
  • 38.2.1 — Initial-Inventar 10-20 Artikel

Abhängigkeiten

  • Vorbedingung: keine (Git-basiert)
  • Wird benötigt von: M173

Out of Scope

  • DB-getriebene Pflege mit Editor-UI → Phase 2 (38.X.1)
  • Mehrsprachigkeit → Phase 2 (38.X.2)
  • KI-Suche → Phase 2 (38.X.3)
  • View-Counts → Phase 2 (38.X.4)

Erfolgskriterium

20 Artikel als Markdown im Repo; Build erzeugt Volltext-Index + Sitemap; Build bricht bei kaputter Kategorie-Ref ab.

Hinweise für Slice-Planung

  • Static-Site-Generation (kein DB-Lookup zur Laufzeit für Artikel-Body)
  • Frontmatter-Validierung als Build-Step

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.