Zum Hauptinhalt springen

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> oder NO_DOC_LINK: <Grund> gemäss Richtlinie.

Pflichtabschnitte mit Mindesttiefe

  1. Pipeline-Scope
    • Input, Output, Trigger und Abhängigkeiten.
  2. Vertrags-/Schnittstellenregeln
    • Datenverträge der Ein- und Ausgänge, erlaubte Versionen.
  3. DQ- und Gate-Logik
    • Pass/Fail-Kriterien, manuelle Entscheidungen, Abbruchbedingungen.
  4. Incident-Handling
    • Alerting, Severity, Eskalationskette, Recovery-Schritte.
  5. Betrieb & Ownership
    • On-Call-Verantwortung, Runbook, Change-Verfahren.

Workflow: neue Pipeline-Seite

  1. Seite anlegen und eindeutigen slug setzen.
  2. Falls BPMN betroffen: Knoten-Referenz und ## BPMN-Kontext ergänzen.
  3. Traceability-Eintrag prüfen/aktualisieren.
  4. Links gemäss BPMN-Linking-Richtlinie prüfen.
  5. pnpm run link-check ausfü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.