MVP-001-HUMAN-READABLE-CODE-CONTRACT-RULES

MVP-001 – Regeln für menschenlesbare Code-Verträge#

Modulvertrag#

Jeder größere Codeblock beschreibt:

1. fachlichen Zweck,
2. Capability-, Reference-BB- und Solution-BB-Herkunft,
3. Verantwortungen,
4. Ausschlüsse,
5. Invarianten,
6. öffentliche Ports und Use Cases,
7. Tests,
8. Link zum ⌘ArtifactEin Artefakt ist jede eindeutig identifizierbare fachliche, technische, organisatorische oder reale Einheit, die in der Engineering-Landschaft modelliert wird. Manifest.

Öffentliche Go-Verträge#

Dokumentiert werden mindestens:

• exportierte Domain-Typen,
• Repository- und Service-Ports,
• Application Services,
• Commands und Queries,
• Konstruktoren,
• öffentliche Methoden mit fachlicher Wirkung.

Der Kommentar erklärt Wirkung, fachliche Voraussetzungen, Nebenwirkungen und wichtige Fehler. Er wiederholt nicht nur den Namen.

Use-Case-Dokument#

Zentrale Abläufe erhalten eine Datei neben dem Application ⌘CodeCode ist eine ausführbare oder interpretierbare technische Realisierung, die durch Tests und Runtime-Evidence überprüfbar bleibt., etwa:

application/
                ├── service.go
                ├── save-revision.md
                └── service_test.go

Frontend#

Für sichtbare Commands und Workbench Services gilt dasselbe Prinzip. Die Dokumentation erklärt insbesondere:

• fachlichen Auslöser,
• Kontext- und Berechtigungsregeln,
• erwartete Serverwirkung,
• Konflikt- und Fehlerszenarien,
• HelpContextId.

Beziehungen#

• ◆MVP-001 – Mehrsprachige ArtefaktplattformVerbindlicher Solution Contract für das erste produktive Plateau der Engineering Platform. — constrains