requirement.md

Requirement diagrams cheatsheet

Official documentation.

Defining requirements

requirementDiagram
    requirement UptimeRequirement {
        id: 1
        text: Site Uptime 
        risk: Medium
        verifymethod: Analysis
    }

Loading

• requirement can be replaced by functionalRequirement, interfaceRequirement, performanceRequirement, physicalRequirement, or designConstraint.
• risk can be defined as Low, Medium, or High.
• verifyMethod can be defined as Analysis, Inspection, Test, or Demonstration.

Defining elements

requirementDiagram
    element myEntity {
        type: MyElement
        docref: ABC123
    }

Loading

Defining relationships

    requirementDiagram

    requirement UptimeRequirement {
        id: 1
        text: Site Uptime 
        risk: Medium
        verifymethod: Analysis
    }

    element satisfyingElement {
        type: MyElement
        docref: ABC001
    }

    element containingElement {
        type: MyElement
        docref: ABC002
    }

    satisfyingElement - satisfies -> UptimeRequirement
    containingElement - contains -> UptimeRequirement

Loading

• satisfies can be replaced by contains, copies, derives, verifies, refines, or traces.