業務の手順を人に伝えるとき、文章だけでは足りない場面があります。「この場合はこちら、それ以外はこちら」という分岐が入ると、箇条書きは途端に読みにくくなる。図にすれば一目なのですが、作図ツールを開いて四角を並べ、矢印を繋ぎ、位置を揃えて……という作業がまず面倒です。
さらに面倒なのは修正です。工程が1つ増えるたびに、後ろの図形を全部ずらして矢印を引き直す。「あとで直そう」と思った図は、たいてい古いまま残ります。
Mermaidは、この「図を描く」作業を「テキストを書く」作業に置き換える記法です。図形の位置は指定しません。何と何が繋がっているかだけを書くと、配置は自動で決まります。工程が増えたときも、行を1つ足せば図全体が組み直されます。
まず3行だけ書いてみる
いちばん簡単なフローチャートは、これだけです。
flowchart TD
A[申請書を作成] --> B[上長が確認]
B --> C[経理へ提出]
1行目の flowchart TD は「フローチャートを上から下(Top-Down)に描く」という宣言です。2行目以降は「AからBへ矢印を引く」という意味で、角括弧の中がその四角に書かれる文字になります。A B C は図には出ません。行の中でその四角を指すための名前です。
このコードをMermaid図エディタに貼ると、入力しながら図が出ます。四角の大きさも矢印の角度も指定していませんが、3つの四角が縦に並んで矢印で繋がった図になります。
業務で使う3つの型
実務で必要になる図は、だいたい次の3つに収まります。それぞれ、貼ればそのまま動くコードを載せます。
1. 条件分岐がある業務フロー
承認フローのように「金額によって承認者が変わる」たぐいの分岐は、波括弧で書きます。
flowchart TD
A[経費を立て替える] --> B[領収書を添えて申請]
B --> C{金額が3万円以上か}
C -->|はい| D[部長が承認]
C -->|いいえ| E[課長が承認]
D --> F[経理が処理]
E --> F
F --> G[給与と一緒に振り込み]
C{金額が3万円以上か} の波括弧が、ひし形(判断)になります。-->|はい| のように矢印の途中へ縦棒で挟んだ文字を書くと、その矢印にラベルが付きます。
注目してほしいのは終盤の2行です。D --> F と E --> F のように、分かれた線が同じ F に向かうと書くだけで、図の上では2本の矢印が1つの四角に合流します。合流点をどこに置くかを考える必要はありません。
2. 一本道の手順図
分岐のない手順は、TD(上から下)の代わりに LR(左から右)と書くと横に並びます。工程の数が少ないときは横のほうが収まりがよく、資料の1ページに貼りやすくなります。
flowchart LR
A[問い合わせを受ける] --> B[内容を記録する]
B --> C[担当者に割り当てる]
C --> D[回答を返す]
D --> E[記録を締める]
工程が増えたときは、行を足して矢印の繋ぎ先を変えるだけです。図形をずらす作業は発生しません。
3. 担当者の間のやりとり
「誰が誰に何を渡すか」を書きたいときは、フローチャートよりシーケンス図が向いています。
sequenceDiagram
participant 顧客
participant 受付
participant 担当部署
顧客->>受付: 問い合わせを送る
受付-->>顧客: 受付番号を返す
受付->>担当部署: 内容を転送する
担当部署-->>受付: 回答を作成する
受付-->>顧客: 回答を返す
participant で登場人物を宣言し、あとは「誰->>誰: 何を」と書いていきます。宣言した順に左から縦線が引かれ、書いた順に上から矢印が並びます。->> は実線、-->> は破線なので、依頼と返答を見た目で分けられます。
引き継ぎ資料で「この作業には誰が関わるのか」を示したいとき、この形が一番早く伝わります。
書き始めてすぐ気になること
ノードの名前は日本語でよい
ここまで A B C を使ってきましたが、工程が10個を超えると「Fってどれだったか」と分からなくなります。名前は日本語でも構わないので、意味のある語を当てておくと、あとから読み返したときに楽です。
flowchart TD
受付[問い合わせを受ける] --> 一次[一次回答を返す]
一次 --> 判断{追加の調査が必要か}
判断 -->|必要| 調査[担当部署へ依頼]
判断 -->|不要| 完了[対応を終える]
調査 --> 完了
判断{追加の調査が必要か} の 判断 は名前、波括弧の中がその図形に書かれる文字です。名前のほうは図には出ません。
ラベルに記号を入れるとエラーになることがある
ラベルの中に半角の括弧を書くと、記法の一部と解釈されてエラーになります。A[申請(様式A)を作成] は通りません。こうした記号を入れたいときは、ラベル全体をダブルクォートで囲みます。
flowchart TD
A["申請(様式A-1)を作成"] --> B["上長が確認 [期限: 3営業日]"]
B --> C[経理へ提出]
囲んでしまえば、半角括弧も角括弧もコロンもそのまま書けます。「エラーが出たらとりあえずダブルクォートで囲む」と覚えておけば、たいていの記号は通ります。
長いラベルは途中で折る
1つの四角に長い文を入れると、その四角だけ横に伸びて図の形が崩れます。折り返したい位置に <br> と書くと、そこで改行されます。
flowchart TD
A["申請書を作成<br>(様式は共有フォルダ)"] --> B[上長が確認]
B --> C[経理へ提出]
書いた図をどこに置くか
Mermaidに対応しているサービスは増えていて、コードブロックにそのまま書くと図として表示される場所があります。GitHubやNotionがその例です。ただし対応の範囲はサービスごとに違い、変わることもあるので、使っている環境で一度試してみるのが確実です。
対応していない場所——社内のワープロ文書やスライドなど——に貼りたいときは、画像として書き出します。Mermaid図エディタにはPNGとSVGの書き出しがあるので、書き出したファイルをそのまま貼り付けられます。SVGは拡大しても輪郭が滑らかなので、印刷する資料にはこちらが向いています。
元のテキストさえ残しておけば、図の修正は「テキストを直して書き出し直す」で済みます。画像だけが手元にある状態と違って、半年後に工程が1つ増えても直せます。
もう一つ、テキストであることの効きめがあります。手順書をドキュメントツールやGitで管理していると、図の変更が行単位の差分として残ります。「先月と比べてどこが変わったのか」を、図を2枚並べて見比べずに追える。画像で管理していた図では、これができませんでした。
まとめ
Mermaidは覚えることの少ない記法です。この記事に出てきたのは、実質的に次の5つだけでした。
flowchart TD/flowchart LRで図の向きを決めるA[文字]で四角、C{文字}でひし形-->で矢印、-->|文字|でラベル付きの矢印sequenceDiagramとparticipantでやりとりの図- 記号でエラーが出たらラベルをダブルクォートで囲む
まず1つ、手元にある業務フローをテキストにしてみてください。分岐が2つ3つある手順でも、書き上がるまで数分です。Mermaid図エディタは入力しながら図が出るので、記法を覚えていなくても、書き換えては結果を見る形で進められます。