Frontmatter Reference¶

FORMAT · FRONTMATTER

All fields are optional unless marked Required. type: is required on every element.

Common fields¶

Label field: name¶

name is the single, universal human-readable label on every element type — Requirement, TestCase, ADR, PartDef, Package, FeatureDef, the safety/security types, everything. There is no longer a per-identity-class split.

• For name-identified types (all SysML structural types, Package, Diagram, and FeatureDef) name is both the label and the identity/QName segment, so the basic-name grammar (W042) applies to it.
• For id-identified types — those whose identity is a stable id (REQ-*, TC-*, HE-*, …): Requirement, TestCase, TestPlan, Configuration, ADR, ConfirmationMeasure, ReviewRecord, TradeStudy, Baseline, PlanningItem, and all safety/security types (HazardousEvent, SafetyGoal, DamageScenario, ThreatScenario, CybersecurityGoal, SecurityControl, VulnerabilityReport, TARASheet, FaultTree/FaultTreeGate/FaultTreeEvent, FMEASheet/FMEAEntry, AttackTree/AttackTreeGate/AttackStep, Argument, AssumptionOfUse) — name is free prose (spaces and punctuation allowed; W042 does not apply) and is required.

title is removed. It is no longer a recognized label field. Declaring title: on any element raises error E025 ("the title field is removed — rename it to name"). Error E024 (formerly: a name: on an id-identified type) is retired — a Requirement carrying id + name validates clean.

FeatureDef is name-identified (its name is its label and QName segment) and also carries a mandatory stable id (its FEAT-* shortName; a feature with no id is E201). The id axis and the name (label) axis are independent.

Features (features:)¶

A list of inline owned features. Each entry is a mapping:

Ports (features: with type: Port)¶

features:
  - name: powerIn
    type: Port
    typedBy: Interfaces::PowerPortDef
    direction: in
  - name: telemetryOut
    type: Port
    typedBy: Interfaces::TelemetryPortDef
    direction: out

Connections (connections:)¶

Internal connections between ports, declared on PartDef or Part files.

connections:
  - from: avionics.telemetryOut
    to: telemetryOut
    typedBy: Interfaces::TelemetryConnectionDef

Binding connections (bindingConnections:)¶

Binds two features to be identical (equality connector).

bindingConnections:
  - left: airframe.telemetryOut
    right: telemetryOut

Traceability fields (Requirements)¶

Native element fields (ReviewRecord, TradeStudy, PlanningItem, budget)¶

These id-identified native types carry their own field sets (full schema in Element Types and syscribe spec fields):

State machine transitions (StateDef/State)¶

The canonical transition schema (§8.8.3) is source / target / accept{payload,via} / guard / effect, authored either nested under a subStates: entry (implicit source) or top-level (explicit source:); isInitial/isFinal mark the initial/final substates. The legacy from/to/trigger keys are accepted as aliases but deprecated (W075). Hierarchy/region-aware completeness checks are W070–W079.

Traceability fields (TestCases)¶

TestPlan fields (type: TestPlan)¶

A TestPlan (stable TP-* id) groups reusable TestCases by product and scope.

Effective members = testCases ∪ selection matches. Surfaced by testplan and the --plan TP-X lens on matrix/verification-depth/audit. Codes E600–E606 / W610–W616 in the Rule Reference.

Multi-repository composition (repoImports:, §14)¶

A Package _index.md may mount a sub-tree from a peer repository declared in the [repos] table of the model-root .syscribe.toml. Cross-repo references resolve against the local model first, then each repo in declaration order (global stable ID or qualified name).

type: Package
name: Integration
repoImports:
  - repo: brakes
    qname: BrakeSystem
    as: Brakes

Validation rules E510–E515/W510–W512 are active only when [repos] is configured — see the Rule Reference and the Multi-Repository Composition guide. A pinned repo (ref:) whose HEAD has drifted raises W511; a submodule peer whose ref: disagrees with the parent's gitlink raises W512. Gate CI on a reproducible composition with validate --deny W511 --deny W512. CLI: repos list|status|sync.

Implementation trace (implementedBy:)¶

Part/PartDef/Interface/InterfaceDef elements may link to the source artifact(s) that realise them, closing the V-model leg Requirement ─satisfies→ Architecture ─implementedBy→ Code ─verifies→ Test.

type: PartDef
satisfies: [REQ-SCHED-001]
implementedBy:
  - src/scheduler/mod.rs
  - repo:src/scheduler/bitmap.rs

User-defined links (links:, §12.10)¶

Any element may carry project-defined relationships under a single links: map. Link types are declared per project in [linkTypes.<name>] tables of the model-root .syscribe.toml — list them with syscribe -m <root> link-types.

type: PartDef
name: WatchdogMonitor
domain: software
links:
  mitigates: [REQ-BRK-002, REQ-BRK-003]

See the Link Types guide for declaring types, extends/relax/coverage, and the follow command.

Diagram fields¶

See Diagrams for full shape and edge schemas.

Operations (operations:)¶

Callable operations and async receptions on PortDef, InterfaceDef, ConnectionDef.

See Operations for the full schema.

Variability / product-line fields (§9)¶

Opt-in: ignored when the model declares no FeatureDef. See the Variability guide.

A Configuration requires id (CONF-*), name, status, and featureModel. Validation codes for these fields are in the Rule Reference (PLE errors E2xx, projection E226/E227, warnings W01x–W022).

Custom fields (custom_fields:)¶