README

Reference Artifacts#

Zweck#

Dieser Bereich definiert die semantische Foundation wiederverwendbarer Architekturbausteine. Er beschreibt ⌘BedeutungBedeutung beschreibt den fachlichen Sinn eines Elements und seine Relevanz für Menschen und Organisationen. und Geltungsbereich, nicht die technische Dateivorlage.

Grundsatz#

Reference Artifacts beschreiben Bedeutung. Templates beschreiben Materialisierung.

Markdown, JSON, HTML, Datenbank, UI und weitere Formate sind mögliche Materialisierungen derselben semantischen Quelle.

Foundation-Kategorien#

85-reference-artifacts/
                ├── README.md
                ├── reference-artifact/
                ├── reference-model/
                ├── reference-process/
                ├── reference-pattern/
                └── reference-building-block/

Die Kategorien sind keine gegenseitig vollständig ausschließenden Dateitypen. Ein komplexes Konzept kann Beziehungen zu mehreren Kategorien besitzen. Seine primäre fachliche Verantwortung muss dennoch eindeutig sein.

Qualitätsregeln#

Ein Reference ⌘ArtifactEin Artefakt ist jede eindeutig identifizierbare fachliche, technische, organisatorische oder reale Einheit, die in der Engineering-Landschaft modelliert wird. oder eine der verwandten Kategorien muss mindestens dokumentieren:

• Identität,
• Zweck,
• Geltungsbereich,
• Verantwortlichkeit,
• Eigenschaften,
• Beziehungen,
• Invarianten beziehungsweise Regeln,
• Lebenszyklus,
• mögliche Materialisierungen,
• Provenienz und Version.

Gehört ausdrücklich nicht hier hinein#

• konkrete lokale .env-Werte oder Secrets,
• generierte Runtime-Ausgaben,
• technische Templates ohne semantische Aussage,
• solution-spezifische Ausprägungen, wenn die Aussage nicht allgemein gültig ist,
• unkontrollierte Kopien führender Quellen.

Beziehungen#

• Reference Models verbinden mehrere Reference Artifacts.
• Reference Processes beschreiben standardisierte Abläufe und Zustandsübergänge.
• Reference Patterns beschreiben wiederverwendbare Lösungsansätze.
• Reference Building Blocks beschreiben lösungsneutrale, wiederverwendbare Realisierungsbausteine.
• Engineering Tools stellen technische Templates und Materialisierer bereit.
• Repository Contracts wenden diese Foundation auf konkrete Repositories an.

Knowledge Management#

• reference-building-block/knowledge-management.md
• reference-model/knowledge-reference-model.md

Engineering Findings#

• engineering-findings/README.md
• reference-model/engineering-finding-model.md
• reference-process/knowledge-evolution-process.md

Engineering Findings halten validierte Erkenntnisse aus realer Implementierung und Betrieb fest. Sie verbinden Observation, Entscheidung, Implementierung, Verification, ⌘EvidenceTechnical documentation artifact. und Learning.