Markdown requirement diagram maker

Document requirements and how they link to your design. Mermaid requirement diagrams connect specs, elements and verification in one picture.

Mermaid requirement syntax

A requirement diagram has requirements, elements that realise them, and links between the two. Each requirement carries an id, text, a risk level and how it is verified. Here is each piece you can write.

Requirements

Declare a requirement with an id, its text, a risk level and a verification method.

You write

requirementDiagram
  requirement r1 {
    id: 1
    text: shall respond in 1s
    risk: high
    verifymethod: test
  }

You get

Elements and links

Add an element that realises the work, then link it to a requirement with a verb.

You write

requirementDiagram
  requirement r1 {
    id: 1
    text: fast response
  }
  element e1 {
    type: simulation
  }
  e1 - satisfies -> r1

You get

Cheat sheet

Write this	You get
Fields
`risk: low / medium / high`	Risk level
`verifymethod: test`	analysis, inspection, test or demonstration
Kinds
`requirement`	A plain requirement
`functionalRequirement`	Also interface, performance, physical, designConstraint
`element name { type: ... }`	A design element
Links
`A - satisfies -> B`	A satisfies B
`A - traces -> B`	Also derives, contains, copies, verifies, refines