Adding Model

Zweck

Leitfaden für Autor:innen, um Model-Dokumentation vollständig, messbar und traceable zu erstellen.

Autorenrichtlinien (verbindlich)

• Keine Platzhalter oder unkonkrete Aussagen in finalen PRs.
• Modellbegriffe (z. B. Drift, Feature, Label) gegen den Glossary konsistent verwenden.
• Prozessknoten und Evidenz mit der Traceability Matrix abgleichen.
• Bei BPMN-Referenzen nur /docs/<slug>-Links nutzen.

Pflichtabschnitte mit Mindesttiefe

1. Business-Ziel & Hypothese
   • Messbares Ziel (z. B. KPI-Verbesserung, Risiko-Reduktion).
2. Trainingsartefakte
   • Feature-/Label-Versionen, Trainingsfenster, Datenabdeckung.
3. Acceptance-Kriterien
   • Quantitative Mindestschwellen (z. B. Precision, Drawdown, Stabilität).
4. Governance & Freigabe
   • Rollen, Gate-Entscheidungen, notwendige Evidenzen.
5. Incident-/Rollback-Plan
   • Trigger, Verantwortliche, Fallback-Modell oder letzte stabile Version.

Workflow: neue Modellseite

1. Seite mit slug anlegen.
2. Pflichtabschnitte mit konkreten Zahlen/Schwellen ausfüllen.
3. Verlinkung auf Glossary und Traceability ergänzen.
4. BPMN-Bezug (## BPMN-Kontext) ergänzen, falls der Knoten gemappt ist.
5. pnpm run link-check ausführen.

Review-Kriterien

• Aussagen sind überprüfbar (nicht nur „gut“, sondern mit Metriken).
• Governance- und Incident-Pfade sind eindeutig benannt.
• Keine offenen Placeholder-Marker.

Siehe auch: Adding Pipeline, Contributor Guide, BPMN-Linking Richtlinie.