Adding Dataset

Zweck

Checkliste für Autor:innen, um neue Dataset-Seiten fachlich belastbar, wiederverwendbar und CI-sicher zu dokumentieren.

Autorenrichtlinien (verbindlich)

• Keine Platzhaltertexte in finalen Seiten (z. B. TODO, TBD, „Zweck der Seite in 1 Satz“).
• Jeder neue Begriff wird auf den Glossary abgeglichen.
• Prozessbezug und BPMN-Knoten werden gegen die Traceability Matrix geprüft.
• Interne Links ausschliesslich als /docs/<slug> pflegen.

Pflichtabschnitte mit Mindesttiefe

1. Zweck & Scope
   • Welche fachliche Entscheidung die Daten unterstützen.
   • Welche Teams die Daten konsumieren.
2. Data Contract
   • Owner, schema_version, Freshness-SLO, DQ-Regeln, Incident-Trigger.
3. Versionierung
   • Wie Änderungen (Breaking/Non-Breaking) versioniert werden.
   • Wie Reproduzierbarkeit (Snapshot + Run-ID) gewährleistet ist.
4. DQ-Übergabe
   • Konkrete Pass/Fail-Regeln.
   • Übergabeziel (Warehouse/Feature Store) inkl. Evidenz.
5. Incident-Verknüpfung
   • Wann automatisch ein Incident erstellt wird.
   • Eskalationsweg und Recovery-Verantwortung.

Workflow: neue Dataset-Seite

1. Datei unter site/docs/** anlegen und slug vergeben.
2. Pflichtabschnitte ausfüllen (kein Placeholder verbleibt).
3. Glossary- und Traceability-Referenzen setzen.
4. Falls BPMN-bezogen: ## BPMN-Kontext mit IDs + Input/Entscheidungs-/Output-Bezug ergänzen.
5. pnpm run link-check ausführen und Fehler beheben.

Review-Kriterien

• Inhalt ist ohne Template-Text und mit messbaren Aussagen formuliert.
• Datenvertrag, DQ-Übergabe und Incident-Logik sind eindeutig.
• Links und Slugs sind CI-konform.

Siehe auch: Contributor Guide, BPMN-Linking Richtlinie, Local Setup.