diagram

目的

描く内容の種類から図種を決める。

内容の種類から図種へ

• 手順、依存、構成: flowchart。ノードは 15 個までに抑える。線がまたぐ境界を 示したいときだけ subgraph を足す
• 構成要素と、そのグループ分け、つなぎ方: architecture-beta
• やり取りの順序、呼び出しの往復: sequenceDiagram
• 状態の遷移: stateDiagram-v2
• 2 軸上の位置づけ、他との相対関係: quadrantChart
• 積層、盤面、配置そのものが情報になる格子: block。どの列にあるか、何列ぶんを 占めるかが意味を持つときに使う
• 集合の重なり: venn-beta
• 原因の分解: ishikawa-beta
• 因果のループ、要素が輪になって互いを強める、または打ち消す関係: flowchart に 約束事を載せる。Mermaid に専用の図種はない
• 時系列上の変化: timeline
• マインドマップ: markmap.md に従う。Mermaid の mindmap は使わない
• AWS の構成図: aws-guide.md に従う
  • 骨組みや比較図を書くときは aws-template.md を読む
  • アイコンの URL やノード ID の付け方を調べるときは aws-icons.md を読む
  • コンソールへの click 行を足すときは aws-console-urls.md を読む
• 入れ子や対応を並べるだけ: 図にしない。箇条書きで書く

quadrantChart、block、architecture-beta、venn-beta、ishikawa-beta、 timeline、因果のループを書く前に patterns.md を読む。それ以外の図種は そこに載せていない。

壊れやすい箇所

• ノードラベルは常にダブルクォートで囲む。A[foo (bar)] は構文エラーになり、 A["foo (bar)"] はならない。波括弧を含むラベルも同じ
• 小文字の end をノード ID に使わない。flowchart が壊れる
• --- の直後に小文字の o や x で始まるノード ID を置かない。矢印が黙って 丸や罰の形に変わる。ID の先頭を大文字にするか、ノード名を変える
• 図種の開始キーワードは references/patterns.md からそのまま写す。-beta が 付くかどうかは図種ごとに違い、勘で書くと構文エラーになる

どれも当てはまらないとき

上の一覧に合う図種がなければ、info だけを含む Mermaid のコードフェンスを開いて 描画側が動かしている版を確かめ、その図種が使えることを確認したうえで、上の一覧に 足す。