Requirement Diagram

Use Mermaid requirementDiagram to document requirements, relationships, traceability, and verification links.

Basic template

requirementDiagram
    requirement r1 {
        id: R1
        text: System must authenticate users
        risk: medium
        verifymethod: test
    }

Core syntax

• Start with requirementDiagram
• Define items such as requirement, functionalRequirement, and performanceRequirement
• Common fields:
  • id:
  • text:
  • risk:
  • verifymethod:
• Connect requirements with relationships like:
  • contains
  • copies
  • derives
  • satisfies
  • verifies

Common example

requirementDiagram
    functionalRequirement auth {
        id: FR-1
        text: Users must sign in with MFA
        risk: high
        verifymethod: test
    }

    performanceRequirement loginSpeed {
        id: PR-1
        text: Sign-in must complete in under 2 seconds
        risk: medium
        verifymethod: analysis
    }

    element service {
        type: component
        docRef: AuthService
    }

    auth - contains -> loginSpeed
    service - satisfies -> auth
    service - verifies -> loginSpeed

Good for

• Traceability notes
• Regulated work
• System requirement mapping

Watch for

• Keep requirement text concise or the diagram becomes unreadable
• This works best when paired with prose that defines scope and acceptance criteria