Mermaid.js-Anforderungsdiagramm-Syntax & Leitfaden zur Rückverfolgbarkeit

Ein Anforderungsdiagramm ist ein spezialisiertes ingenieurwissenschaftliches Visualisierungswerkzeug, das von Systemarchitekten, Produktmanagern und Softwareentwicklern genutzt wird, um technische Spezifikationen, Systembeschränkungen und Verifikationstests darzustellen. Auf der SysML-(Systems Modeling Language)-Standardbasis aufgebaut, ermöglicht der native requirementDiagramEngine können Sie abstrakte Entwurfsanforderungen direkt mit physischen Systemkomponenten und Testfällen über textbasierte Angaben verknüpfen.

Verständnis der Elemente des Anforderungsdiagramms

Ein Anforderungsdiagramm besteht hauptsächlich aus zwei unterschiedlichen strukturellen Bausteinen: Anforderungsblöcke (die die Regeln festlegen) und Elementblöcke (die den Code, die Hardware oder die Testskripte modellieren). Beziehungen werden dann zwischen diesen Blöcken gezeichnet, um eine klare Rückverfolgbarkeitsmatrix zu erstellen.

Grundlegende Syntaxstruktur

Jedes Diagramm beginnt mit dem requirementDiagramDeklarationskopf. Danach folgt die Definition von Anforderungsblöcken mit verschachtelten Eigenschaften, Elementblöcken und gerichteten Beziehungslinien.

requirementDiagram
  requirement test_req {
    id: 1
    text: "Das System muss Zahlungen sicher verarbeiten."
    risk: hoch
    verifymethod: test
  }

Die vollständige Anforderungstypen-Taxonomie

Nicht alle ingenieurwissenschaftlichen Anforderungen sind gleich. Die Engine bietet sechs unterschiedliche Block-Schlüsselwörter, um Ihre Spezifikationen visuell und semantisch zu klassifizieren. Jeder Typ verändert die im gerenderten Diagrammkasten angezeigte Kopfzeile:

• requirement: Eine Standard- oder allgemeine Systemspezifikation.
• functionalRequirement: Bestimmt eine Aktion oder ein Verhaltensmerkmal, das das System ausführen muss.
• interfaceRequirement: Definiert Verbindungsstellen, Datenaustausch oder Kommunikationsprotokolle zwischen Komponenten.
• performanceRequirement: Legt messbare Ausführungsmaßstäbe fest, wie Geschwindigkeit, Skalierbarkeit, Durchsatz oder Kapazität.
• physicalRequirement: Bestimmt Materialbeschränkungen, Abmessungen, Gewicht oder Hardware-Beschränkungen.
• Designbeschränkung: Beschränkt die Auswahl von Software, Architekturstilen, Frameworks oder Compliance-Standards.

Anforderungsdiagramm
  designConstraint legacy_constraint {
    id: "CON-04"
    text: "Der Backend muss die Rückwärtskompatibilität mit PHP 8.2-Pipelines aufrechterhalten."
    risk: low
    verifymethod: Inspektion
  }

Syntaxreferenz: Anforderungselemente und Modifikatoren

Die Tabelle unten zeigt die primären semantischen Schlüsselwörter, erforderlichen Attribute und Klassifizierungsstrukturen, die vom Anforderungsinterpreter native erkannt werden.

Erweiterte Beziehungen und Spurbarkeitsverknüpfungen

Die Hauptstärke eines Anforderungsdiagramms liegt darin, Anforderungen mit realen Systemen zu verbinden. Verbindungen werden mit spezialisierten, typisierten Pfeilverbindern gezeichnet (z. B. - erfüllt ->) die eine klare strukturelle Absicht herstellen.

Unterstützte Beziehungsoperatoren

Benutzerdefinierte Elemente & Erweiterte Attribute

Zusätzlich zu den Standardanforderungen ermöglicht der elementSchlüsselwort ermöglicht es Ihnen, spezifische Anwendungs-Skripte, Hardware-Elemente oder Drittanbieter-Pakete in Ihre Trace-Pfade einzubinden. Jeder Element-Block kann benutzerdefinierte Schlüssel-Wert-Metadaten-Eigenschaften speichern, indem er das type:Schema innerhalb seiner geschweiften Klammern nutzt.

requirementDiagram
  element payment_gateway_api {
    type: "Stripe-Mikroservice-Modul"
  }
  
  element compliance_audit_log {
    type: "Immutableer Datenbanktabelle"
  }

Realitätsnahe Blueprint: Komplexe E-Commerce-Sicherheitsinfrastruktur

Dieser umfassende Blueprint verfolgt ein vollständiges Produktions-Konformitäts-Ökosystem. Er zeigt die Dekomposition über contains, ordnet Leistungsbeschränkungen zu, verbindet Software-Module über satisfies, und ordnet Integrations-Testfälle über verifiesSchleifen zu.

requirementDiagram
  
  %% Anforderungshierarchie-Ebene
  requirement security_master_req {
    id: "SEC-001"
    text: "Die Anwendungsplattform muss strenge PCI-DSS-Standardsachkonformität aufrechterhalten."
    risk: high
    verifymethod: test
  }

  performanceRequirement checkout_speed_req {
    id: "PERF-22"
    text: "MFA-kryptographische Authentifizierungs-Handshakes müssen in weniger als 200ms kompiliert werden."
    risk: medium
    verifymethod: analysis
  }

  interfaceRequirement secure_token_req {
    id: "INT-09"
    text: "API-Datenübertragungen müssen verschlüsselte JSON-Web-Tokens (JWT) verwenden."
    risk: high
    verifymethod: test
  }

  %% Systemelemente-Ebene
  element auth_service_code {
    type: "Go-Backend-Mikroservice"
  }

  element load_tester_script {
    type: "K6-Leistungs-Skript"
  }

  element jwt_validator_test {
    type: "Jest-Integration-Einheitstest-Suite"
  }

  %% Architektonische Beziehungspfade
  security_master_req - contains -> checkout_speed_req
  security_master_req - contains -> secure_token_req
  
  auth_service_code - satisfies -> secure_token_req
  load_tester_script - verifies -> checkout_speed_req
  jwt_validator_test - verifies -> secure_token_req

Häufige Syntax-Fehler & Systembeschränkungen

Beim Kompilieren präziser Ingenieurkarten sollten diese Validierungsparameter berücksichtigt werden, um Parsing-Fehler zu vermeiden:

• Pflichtfeld für doppelte Anführungszeichen bei Zeichenketten:Textblöcke und Typen (z. B. text: "Beschreibung", type: "Komponente") *müssen* in doppelte Anführungszeichen gesetzt werden. Die Verwendung von einfachen Anführungszeichen oder daslassen von Zeichenketten unzitiert führt zum Absturz des Compilers.
• Strenge Attributsyntax: Attribute innerhalb von Klammern müssen Doppelpunkte gefolgt von Werten verwenden (z. B. id: 1). Das Vergessen des Doppelpunkts oder das Schreiben auf derselben Zeile ohne korrekte Einrückung kann Fehler verursachen.
• Eingeschränkte Wertewahl: Das risk und verifymethod Parameter akzeptieren nur explizite Systemtokens (z. B. low, medium, high für risk; analysis, demonstration, inspection, test für verifymethod). Das Eingeben benutzerdefinierter Werte wie risk: extreme wird den Layout-Builder beschädigen.
• Integrität der Pfeilabstände: Richtungslinien müssen mit Leerzeichenabstand um die Operatoren eingegeben werden (z. B. A - erfüllt -> B). Das Zusammenfassen der Zeichenkette zu A-satisfies->B wird Systemverarbeitungs-Ausnahmen entfernen.