Zum Inhalt springen
RUMLRUML

Open Format for Digital Law

1.2 Konventionen dieses Dokuments

1.2 Konventionen dieses Dokuments

Anforderungsstufen (RFC 2119)

Diese Spezifikation verwendet die Schlüsselwörter aus RFC 2119 zur Kennzeichnung von Anforderungsstufen. Die Übersetzung der englischen Begriffe erfolgt nach der folgenden Tabelle:

SchlüsselwortEnglischBedeutung
MUSSMUST, SHALLAbsolute Anforderung
ERFORDERLICHREQUIREDAbsolute Anforderung
DARF NICHTMUST NOT, SHALL NOTAbsolutes Verbot
SOLLTESHOULDStarke Empfehlung; Abweichung erfordert begründeten Anlass
EMPFOHLENRECOMMENDEDStarke Empfehlung; Abweichung erfordert begründeten Anlass
SOLLTE NICHTSHOULD NOTStarke Empfehlung dagegen; nur mit begründetem Anlass
NICHT EMPFOHLENNOT RECOMMENDEDStarke Empfehlung dagegen; nur mit begründetem Anlass
DARFMAYWirklich optional
OPTIONALOPTIONALWirklich optional

Die Schlüsselwörter sind nur in Großbuchstaben normativ. Die Pluralformen MÜSSEN, DÜRFEN und SOLLTEN und gebeugte Formen wie ERFORDERLICHES sind dieselben Schlüsselwörter; NICHT darf durch die Satzstellung vom Verb getrennt stehen („DARF role NICHT deklarieren“) oder als KEIN, KEINE, KEINEN usw. am Substantiv stehen („DARF KEIN children-Array haben“).

Notation

KonventionFormBeispiel
JSON-BeispielFenced Code Block mit json-Highlighting"lexId": "1"
PlatzhalterSpitze Klammern<lexId>
Optionales ElementMarkiert [optional]field [optional]
WiederholungAuslassungspunkte..., ...
PatternRegulärer Ausdruck (ECMA-262)^[1-9][0-9]*$
FeldtypVerweist auf Datentypen in Kapitel 3.2UUID, DateTime

Benennungs-Konventionen

RUML unterscheidet schema-definierte Felder von nutzerdefinierten Identifikatoren über die Schreibweise:

  • Schema-definierte Felder verwenden Camel-Case — z. B. lexId, id, children, containerPath, validFrom, documentType, decisionMode, expression, onTrue.
  • Nutzerdefinierte Identifikatoren verwenden Snake-Case — z. B. DataPoint-IDs (dp_annual_income), Context-IDs (ctx_court_ruling) und Text-IDs (text_bgb_823) (Regel DP-02DP-02 Der Schlüssel eines DataPoints, die ID eines Sets und die Schlüssel der fields eines Sets MÜSSEN dem Muster [a-z_][a-z0-9_]* entsprechen.).
  • Implementierungsdefinierte Identifikatoren wie zum Beispiel Referenzen auf Actions oder AI-Models SOLLTEN Snake-Case verwenden — z. B. document_service, manual_review_workflow.

Tools SOLLTEN dieser Konvention beim Erzeugen neuer Identifikatoren folgen. Capability-IDs folgen ihrer eigenen Namespace-Konvention gemäß Kapitel 4.4.