Adding Pipeline
Zweck
Standard für Autor:innen zur Dokumentation neuer Pipelines inkl. BPMN-Verknüpfung, DQ-Übergaben und Betriebsverantwortung.
Autorenrichtlinien (verbindlich)
- Keine Template-/Platzhaltertexte in finaler Dokumentation.
- Pipeline-Begriffe und Rollen mit Glossary harmonisieren.
- BPMN-Knoten und Evidenz gegen Traceability Matrix validieren.
- BPMN-Drilldowns ausschliesslich mit
/docs/<slug>oderNO_DOC_LINK: <Grund>gemäss Richtlinie.
Pflichtabschnitte mit Mindesttiefe
- Pipeline-Scope
- Input, Output, Trigger und Abhängigkeiten.
- Vertrags-/Schnittstellenregeln
- Datenverträge der Ein- und Ausgänge, erlaubte Versionen.
- DQ- und Gate-Logik
- Pass/Fail-Kriterien, manuelle Entscheidungen, Abbruchbedingungen.
- Incident-Handling
- Alerting, Severity, Eskalationskette, Recovery-Schritte.
- Betrieb & Ownership
- On-Call-Verantwortung, Runbook, Change-Verfahren.
Workflow: neue Pipeline-Seite
- Seite anlegen und eindeutigen
slugsetzen. - Falls BPMN betroffen: Knoten-Referenz und
## BPMN-Kontextergänzen. - Traceability-Eintrag prüfen/aktualisieren.
- Links gemäss BPMN-Linking-Richtlinie prüfen.
pnpm run link-checkausführen und erst danach PR erstellen.
Review-Kriterien
- Pipeline ist operativ betreibbar dokumentiert (nicht nur konzeptionell).
- DQ-Übergabe und Incident-Pfade sind konkret und testbar.
- Link- und Routing-Regeln sind eingehalten.
Siehe auch: BPMN-Linking Richtlinie, Contributor Guide, Local Setup.