MarineOS Documentation Standard (MOS-000)
Status: Accepted
Version: 1.0
Owner: MarineOS Architecture Board
1. Zweck
Diese Spezifikation definiert den Aufbau aller Architektur- und Spezifikationsdokumente innerhalb von MarineOS.
Alle zukünftigen Dokumente MÜSSEN diesem Standard folgen.
2. Dokumentkopf
Jede Spezifikation beginnt mit
- Titel
- Status
- Version
- Owner
3. Status
Zulässige Status sind
- Draft
- Review
- Accepted
- Deprecated
- Superseded
4. Dokumentstruktur
Jede Spezifikation besitzt folgenden Aufbau
-
Zweck
-
Definitionen
-
Modell
-
Architekturregeln
-
Beispiele
-
Referenzen
-
Änderungsverlauf
5. Normative Sprache
Es werden ausschließlich folgende Begriffe verwendet.
MUSS
SOLL
DARF
6. Single Source of Truth
Jeder Begriff wird genau einmal definiert.
Andere Dokumente referenzieren ausschließlich diese Definition.
7. Änderungen
Architekturänderungen erfolgen ausschließlich
- durch neue Spezifikationsversionen
oder
- durch Architecture Decision Records (ADR).