手順を追える Mermaid フロー図を書き出す
事実確認の循環を Mermaid で作り、ノード名、表示ラベル、分岐、判断への戻りを確認します。構文が崩れた場合は最初の接続に絞り、意図しないノードや誤った矢印は手順と照合します。掲載先で読める方向とサイズを選び、書き出した画像、文章の要約、編集用の原稿をそろえます。
分かりやすいフロー図なら、作者に矢印を一本ずつ説明してもらわなくても、判断の流れを追えます。Mermaid から画像で、確認できる小さな手順から始めましょう。ここでは、下書きが事実確認を通過するか、修正へ戻るレビューの循環を使います。
最初に、開始、判断、結果を書き出します。この例には、原稿準備、事実確認、書き出し、修正の四つのノードがあります。修正後は同じ判断に戻ります。この戻りの線がなければ、修正で手順が終わるように見えてしまいます。
ノードには変わらない識別名を付け、表示ラベルで作業内容を説明します。Draft と Review は識別名で、図形内の文章がラベルです。Mermaid のフロー図ドキュメントで、この違いと方向指定の構文を確認できます。
一行目で左から右への方向を指定しています。二つの分岐には文字ラベルがあるため、色だけで意味を判断する必要がありません。これはデモ用の手順で、実際のリリースがレビューに通った証拠ではありません。
画像は編集作業の引き継ぎや短い手順書で使う想定です。結果の両方の経路を追ってください。通過した経路は書き出しへ進み、もう一方は修正を経て事実確認へ戻ります。
描画に失敗したら、まずラベルや図形を囲む角括弧と波括弧が対応しているか確認します。最初の接続だけに減らし、残りを一行ずつ戻してみましょう。配置を一度に変更せずに原因を絞れます。
意図しないノードが現れたら、識別名を元の指定と比べます。同じ識別名は同じノードにつながりますが、綴りの違いは別のノードを表す場合があります。描画できても矢印が誤った手順へ向かうなら、構文が正しくても流れが間違っています。判断の連続として声に出して読むと確認しやすくなります。
分岐のラベルは短くし、掲載先で読める大きさを確保します。横長の図を狭いページに置くなら、上下方向にするか、複数の小さな図に分けることも考えます。方向を変えたら、配置を再確認してください。
ダウンロードした画像で、ラベルの切れや矢印の分かりにくさを確認します。手順の文章による要約も添え、後から直せるように Mermaid の原稿を残します。すべての経路に無理がなければ、確認済みの Mermaid 図を書き出す準備ができています。