SADR-003-HUMAN-READABLE-CODE-CONTRACT-MATERIALIZATION

SADR-003 – Materialisierung menschenlesbarer Code-Verträge#

Status#

Accepted for MVP-001.

Entscheidung#

Die Engineering Platform materialisiert ADR-003 mit folgenden Regeln:

• jedes aktive Implementation Module besitzt doc.go oder eine Modul-README,
• exportierte fachliche Go-Symbole besitzen Go-Doc-Kommentare,
• zentrale Application Use Cases besitzen eine kurze Markdown-Datei,
• Frontend-Commands und Services erhalten JSDoc beziehungsweise TypeScript-Dokumentation,
• ⌘ArtifactEin Artefakt ist jede eindeutig identifizierbare fachliche, technische, organisatorische oder reale Einheit, die in der Engineering-Landschaft modelliert wird. Manifests referenzieren die Module Contracts und Use Case Contracts,
• Validatoren prüfen Vorhandensein und referenzierte Pfade.

Nicht jede private ⌘FunktionEin Feature ist eine abgegrenzte, nutzbare und lieferbare Ausprägung einer Lösung. benötigt einen Kommentar. Kommentare dürfen ⌘CodeCode ist eine ausführbare oder interpretierbare technische Realisierung, die durch Tests und Runtime-Evidence überprüfbar bleibt. nicht bloß paraphrasieren.

Decision Governance#

Diese SADR ist die führende Solution-Entscheidung für Dokumentation und ausführbare Compliance. Historische Aussagen sind ⌘ProvenanceProvenienz beschreibt die nachvollziehbare Herkunft eines Wissenselements, einer Aussage oder einer abgeleiteten Darstellung. und Begründung, aber keine parallel gültigen Zielentscheidungen.

Historische semantische Quellen#

• ADR-0010 Documentation as Product
• ADR-0045 Executable Architecture Compliance Contracts

Die vollständige Disposition des historischen ADR-Bestands ist in ◆MVP-001-historical-decision-disposition.mdSemantische Disposition des historischen ADR-Bestands gegenüber der aktuellen Solution Architecture. dokumentiert.