Mermaid ドキュメント

Appearance

要件図 ​

要件図は、要件とそれらの相互の接続、および他の文書化された要素との接続の視覚化を提供します。モデリングの仕様は、SysML v1.6で定義されたものに従います。

要件のレンダリングは簡単です。

Code:
mermaid

構文 ​

要件図には、要件、要素、および関係の3種類のコンポーネントがあります。

各定義の文法は以下に定義されています。 <word>のように角括弧で囲まれた単語は、オプションが表に詳述された列挙キーワードです。 user_defined_...は、ユーザー入力が予想される場所で使用されます。

ユーザーテキストに関する重要な注意点: すべての入力は引用符で囲むこともでき、囲まないこともできます。例えば、Id: "ここに例があります"とId: ここに例がありますの両方が有効です。ただし、ユーザーは引用されていない入力に注意する必要があります。別のキーワードが検出されると、パーサーは失敗します。

要件 ​

要件定義には、要件の種類、名前、ID、テキスト、リスク、および検証方法が含まれます。構文は以下の通りです：

<type> user_defined_name {
    id: user_defined_id
    text: user_defined text
    risk: <risk>
    verifymethod: <method>
}

タイプ、リスク、方法は、SysMLで定義された列挙です。

キーワードオプション
タイプrequirement, functionalRequirement, interfaceRequirement, performanceRequirement, physicalRequirement, designConstraint
リスクLow, Medium, High
検証方法Analysis, Inspection, Test, Demonstration

要素 ​

要素定義には、要素名、タイプ、および文書参照が含まれます。これらの3つはすべてユーザー定義です。要素の機能は軽量化を意図していますが、要件が他の文書の一部分に接続されることを可能にします。

element user_defined_name {
    type: user_defined_type
    docref: user_defined_ref
}

関係 ​

関係は、ソースノード、宛先ノード、および関係タイプで構成されます。

それぞれは、以下の定義形式に従います。

{name of source} - <type> -> {name of destination}

または

{name of destination} <- <type> - {name of source}

「ソースの名前」と「宛先の名前」は、他の場所で定義された要件または要素ノードの名前である必要があります。

関係の種類は、contains、copies、derives、satisfies、verifies、refines、またはtracesのいずれかです。

各関係は図の中でラベル付けされます。

大きな例 ​

この例では、図のすべての機能を使用しています。

Code:
mermaid