Skip to main content

rqml (root)

Summary

Root container for an RQML document.

Where it appears

  • Document root.

Content model

  • meta (1)
  • catalogs (0..1)
  • domain (0..1)
  • goals (0..1)
  • scenarios (0..1)
  • requirements (1)
  • behavior (0..1)
  • interfaces (0..1)
  • verification (0..1)
  • trace (0..1)
  • governance (0..1)

Attributes

NameTypeRequiredDefaultDescription
versionxs:tokenyesSchema version (must match the schema).
docIdIdTypeyesStable document identifier.
statusStatusType (`draftreviewapproveddeprecated`)

Example (minimal)

<rqml xmlns="https://rqml.org/schema/2.1.0" version="2.1.0" docId="DOC-001" status="draft">
<meta>
<title>Example Spec</title>
<system>Example System</system>
</meta>
<requirements/>
</rqml>

Example (typical)

<rqml xmlns="https://rqml.org/schema/2.1.0" version="2.1.0" docId="PAY-REQS" status="review">
<meta>...</meta>
<catalogs>...</catalogs>
<domain>...</domain>
<goals>...</goals>
<scenarios>...</scenarios>
<requirements>...</requirements>
<behavior>...</behavior>
<verification>...</verification>
<trace>...</trace>
<governance>...</governance>
</rqml>

Notes / LLM hints

  • Set version to match the schema version you're using.
  • Ensure all child elements respect ordering shown in the content model.