Elements
graph TD;
%% REQVIRE-AUTOGENERATED-DIAGRAM
%% Graph styling
classDef userRequirement fill:#D1C4E9,stroke:#7E57C2,stroke-width:2px;
classDef systemRequirement fill:#E1D8EE,stroke:#673AB7,stroke-width:1.5px;
classDef verification fill:#DCEDC8,stroke:#4CAF50,stroke-width:2px;
classDef folder fill:#FAFAFA,stroke:#9E9E9E,stroke-width:3px;
classDef file fill:#FFF8E1,stroke:#FFCA28,stroke-width:2px;
classDef default fill:#F5F5F5,stroke:#424242,stroke-width:1.5px;
subgraph 68908f1dbfe487c0["📁 requirements"]
subgraph 922090a32bce0711["📄 Refinements.md"]
e3505bdf96f2e996["Containment Specification"];
class e3505bdf96f2e996 default;
click e3505bdf96f2e996 "Refinements.html#containment-specification";
12b8c722b73f030f["Refinement Specification"];
class 12b8c722b73f030f default;
click 12b8c722b73f030f "Refinements.html#refinement-specification";
32bc0a15650ebf08["Relation Semantics Specification"];
class 32bc0a15650ebf08 default;
click 32bc0a15650ebf08 "Refinements.html#relation-semantics-specification";
a03cf6f1eda0c5c["Supported Element Types Specification"];
class a03cf6f1eda0c5c default;
click a03cf6f1eda0c5c "Refinements.html#supported-element-types-specification";
d3d2eb1636d763ca["Traceability Reporting Specification"];
class d3d2eb1636d763ca default;
click d3d2eb1636d763ca "Refinements.html#traceability-reporting-specification";
a7802cc8074affd0["Verification Coverage Specification"];
class a7802cc8074affd0 default;
click a7802cc8074affd0 "Refinements.html#verification-coverage-specification";
end
end
Containment Specification
Reqvire implements containment hierarchy through filesystem structure.
Details
Folder Structure:
- Folders represent packages/subsystems
- Nested folders create containment hierarchy
- Folder names define namespace for contained elements
File Structure:
- Markdown files contain element definitions
- Elements within a file share the file’s containment context
- File path determines element’s position in hierarchy
Element Identity:
- Full identifier:
path/to/file.md#element-fragment
- Containment derived from file location
- No explicit containment relations needed
Metadata
Relations
Refinement Specification
Reqvire implements requirement refinement through the Details subsection.
Details
SysML Refine Stereotype:
#### Details subsection provides textual refinement- One level of refinement per element
- Elaborates requirement without creating separate child element
Usage:
- Acceptance criteria
- Implementation notes
- Clarifying information
- Rationale and context
Metadata
Relations
Relation Semantics Specification
Reqvire implements SysML relation stereotypes for requirements management.
Details
Requirement Decomposition:
derive/derivedFrom: SysML DeriveReqt stereotype- Parent requirements decompose into child requirements
- Maintains traceability from stakeholder needs to system requirements
Verification Linkage:
verify/verifiedBy: SysML Verify stereotype- Links test cases and verification methods to requirements
- Enables verification coverage analysis
Implementation Satisfaction:
satisfy/satisfiedBy: SysML Satisfy stereotype- Links implementation artifacts (code, designs) to requirements
- Demonstrates requirement fulfillment
General Traceability:
trace: SysML Trace stereotype- Loose coupling between related elements
- Cross-reference without hierarchical dependency
Metadata
Relations
Supported Element Types Specification
Element types supported by the system for classification and behavior determination, aligned with SysML and systems engineering standards.
Details
Requirement Types:
| Type | Description |
|---|
requirement | System requirement (default type if not specified) |
user-requirement | User requirement representing stakeholder needs |
Verification Types:
| Type | Description |
|---|
verification | Verification through testing (equivalent to test-verification) |
test-verification | Explicit verification through testing with documented test procedures |
analysis-verification | Verification through formal analysis of documentation or code |
inspection-verification | Verification through formal inspection or review |
demonstration-verification | Verification through demonstration in a realistic environment |
Refinement Types:
| Type | Description | Constraints |
|---|
constraint | Documents constraints that limit or bound the system | Only satisfy relations allowed |
behavior | Documents behavior details and operational specifications | Only satisfy relations allowed |
specification | Documents detailed specifications and technical descriptions | Only satisfy relations allowed |
Other Types:
| Type | Description |
|---|
other | Generic custom element type |
other-TYPENAME | Named custom element type (e.g., other-interface, other-actor) |
Custom Type Pattern:
- Use
other-TYPENAME where TYPENAME is the custom type name
- TYPENAME must be at least one character (e.g.,
other-x is valid, other- alone is not)
- Custom types can only use
trace relations
Metadata
Relations
Traceability Reporting Specification
Reqvire provides traceability reports per ISO/IEC/IEEE 29148.
Details
Upward Traceability:
- Trace from implementation to requirements
- Trace from tests to requirements
- Verification coverage reports
Downward Traceability:
- Trace from stakeholder needs to system requirements
- Derive chain visualization
- Model-centric hierarchical views
Bidirectional Traceability:
- Impact analysis for requirement changes
- Affected elements identification
- Change propagation tracking
Metadata
Relations
Verification Coverage Specification
Reqvire supports verification coverage analysis per INCOSE best practices.
Details
Coverage Metrics:
- Requirements with verification links (verifiedBy)
- Requirements without verification (coverage gaps)
- Verification completeness percentage
Coverage Reports:
- List unverified requirements
- Group by element type
- Identify critical gaps
Verification Types:
- test-verification: Automated or manual tests
- analysis-verification: Analysis and review
- inspection-verification: Physical inspection
- demonstration-verification: Demonstration of capability
Metadata
Relations