MarineOS Specification Rules (MSR)
Status: Draft
Version: 0.1
1. Zweck
Dieses Dokument definiert die Regeln für alle Architektur- und Spezifikationsdokumente innerhalb von MarineOS.
Alle zukünftigen Spezifikationen MÜSSEN diesen Regeln folgen.
2. Dokumentenarten
MarineOS verwendet folgende Dokumenttypen:
- Vision
- Product Definition
- Architecture Specification
- Information Model Specification
- World Model Specification
- Capability Specification
- Provider Specification
- API Specification
- Architecture Decision Record (ADR)
Jeder Dokumenttyp besitzt genau eine Verantwortung.
3. Normative Sprache
Folgende Begriffe werden normativ verwendet.
MUSS
Eine verbindliche Regel.
SOLL
Eine empfohlene Regel.
DARF
Optionales Verhalten.
4. Dokumentstruktur
Jede Spezifikation MUSS folgenden Aufbau besitzen.
-
Einleitung
-
Zweck
-
Geltungsbereich
-
Begriffe
-
Anforderungen
-
Modell
-
Beispiele
-
Referenzen
-
Änderungsverlauf
5. Implementierungsfreiheit
Spezifikationen beschreiben niemals
- Programmiersprachen
- Frameworks
- Datenbanken
- Protokolle
- Implementierungsdetails
Sie beschreiben ausschließlich das fachliche Modell.
6. Single Source of Truth
Ein Begriff wird genau einmal definiert.
Andere Dokumente verweisen ausschließlich auf diese Definition.
Doppelte Definitionen sind nicht zulässig.
7. Änderungsprozess
Architekturänderungen erfolgen ausschließlich über
- neue Spezifikationsversionen
- oder ADRs.