Skip to content
Permalink
main
Switch branches/tags

Name already in use

A tag already exists with the provided branch name. Many Git commands accept both tag and branch names, so creating this branch may cause unexpected behavior. Are you sure you want to create this branch?

Mermaid/requirement.md

Go to file
 
 
Cannot retrieve contributors at this time
Requirement diagrams cheatsheet Defining requirements Defining elements Defining relationships
57 lines (44 sloc) 1.3 KB
Raw Blame
Open in GitHub Desktop

Requirement diagrams cheatsheet

Official documentation.

Defining requirements

requirementDiagram
    requirement UptimeRequirement {
        id: 1
        text: Site Uptime 
        risk: Medium
        verifymethod: Analysis
    }
  • 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
    }

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
  • satisfies can be replaced by contains, copies, derives, verifies, refines, or traces.