メインコンテンツへスキップ
見出し画像

Mermaidの書き方を初心者向けに解説!基本文法からAI活用まで【サンプルコード付き】

    こんにちは、Udemy講師の栗原です。

    「Mermaidという図のツールを見かけたけれど、書き方がわからない」

    「AIが出力したMermaidのコードを、自分でも読めるようになりたい」

    そんな方へ向けて、このnoteではMermaid(マーメイド)の書き方を、基本文法からサンプルコード付きで解説していきます。

    フローチャートを題材に基本を押さえたあと、シーケンス図・ガントチャートの書き方、さらにAIにMermaidを書かせる方法まで紹介します。


    ※Mermaidの使い方を体系的に学びたい方は、こちらの講座もご活用ください。

    仕事で使えるMermaid(マーメイド)入門 〜テキストから図を生み出す、生成AI時代の図解スキル〜

    → 講座の詳細はこちら

    Mermaidとは?テキストを書くと図が生成されるツール

    Mermaidは、「テキストを書くと図が自動生成される」ダイアグラムツールです。

    通常、図を作るにはPowerPointやdraw.ioのようなツールで、図形を配置したり矢印をつないだりという作業が必要です。Mermaidでは、それをテキストのコードで表現します。

    たとえば、こんな2行のコードを書くだけで図が完成します。

    flowchart LR
        A[テキストを書く] --> B[図が生成される]
    Mermaid Live Editorでフローチャート図を描いた結果
    Mermaid Live Editorでフローチャートを描いた結果

    Mermaidの特徴は、次の3つです。

    ・テキストベース: 変更履歴を管理しやすく、チームでの共有も簡単

    ・多彩な図に対応: フローチャート、シーケンス図、ガントチャート、マインドマップなど

    ・多様な環境で動作: GitHub・Obsidian・VS Codeなど、Markdownベースのツールにそのまま書ける

    特に近年は、ChatGPTやClaudeなどの生成AIがMermaidのコードを書けることが広く知られるようになり、エンジニア以外のビジネス職にも普及が進んでいます。

    Mermaidはどこに書ける?まずは無料のMermaid Live Editorから

    Mermaidの書き方を練習する場所として、まずお勧めしたいのが公式のオンラインエディタ「Mermaid Live Editor」(mermaid.live)です。

    ・ブラウザだけで使えて、アカウント登録不要・無料

    ・左側にコードを書くと、右側に図がリアルタイムでプレビューされる

    Mermaid Live Editorの画面(左コード・右プレビュー)
    Mermaid Live Editorの画面(左コード・右プレビュー)

    そのほか、Mermaidは以下のような環境でも使えます。

    ・GitHub: READMEやIssueにコードを書くと、そのまま図として表示される(2022年から標準サポート)

    ・Obsidian: プラグインなしでMermaidの図を表示できる

    ・VS Code: 「Markdown Preview Mermaid Support」などの拡張機能でプレビューできる

    ・NotionやZennなど: 一部対応しており、対応サービスは増え続けている

    Mermaidの書き方の基本|フローチャートで文法を覚えよう

    Mermaidの書き方は、フローチャートで覚えるのが一番の近道です。基本文法を1つずつ見ていきましょう。

    (1)1行目に図の種類を宣言する

    flowchart TD

    1行目には「どの種類の図を描くか」を宣言します。flowchart TD は「フローチャートを、上から下(Top to Down)方向で描く」という意味です。

    TD を LR(Left to Right)に変えると、左から右方向に流れるレイアウトになります。縦に長くなりすぎるときはLRを使うと見やすくなります。

    (2)ノード(箱)を書く

    A[スタート]

    A はノードのID、角括弧 [ ] の中が図に表示されるテキストです。

    条件分岐を表すひし形のノードは、波括弧 { } で書きます。

    C{内容は問題ない?}

    (3)矢印でつなぐ

    A --> B[資料を確認する]

    --> が矢印です。矢印の途中にパイプ記号 | で囲んだラベルを付けると、「はい」「いいえ」のようなテキストを矢印に表示できます。

    C --> |はい| D[承認する]
    C --> |いいえ| E[修正を依頼する]

    (4)フローチャートの完成形サンプル

    ここまでの文法を組み合わせると、実務でよくある「確認と差し戻しのフロー」が書けます。コピーしてmermaid.liveに貼り付けてみてください。

    flowchart TD
        A[スタート] --> B[資料を確認する]
        B --> C{内容は問題ない?}
        C --> |はい| D[承認する]
        C --> |いいえ| E[修正を依頼する]
        E --> B
        D --> F[完了]
    フローチャートのレンダリング結果
    フローチャートのレンダリング結果

    まとめると、フローチャートの書き方はこの4つだけです。

    ・四角いノードは [テキスト]

    ・ひし形の条件分岐は {テキスト}

    ・矢印は -->

    ・矢印へのラベルは |テキスト|

    シーケンス図の書き方

    システムや人のやりとりを時系列で表すシーケンス図も、Mermaidでよく使われる図です。

    1行目に sequenceDiagram と宣言し、次に「参加者」を定義します。

    sequenceDiagram
        participant A as 顧客
        participant B as ECサイト
        A->>B: 商品を注文する
        B-->>A: 注文確認メールを送る

    書き方のポイントは次のとおりです。

    ・participant A as 顧客 : アルファベットのIDに、as で日本語の表示名を付ける

    ・A->>B: メッセージ : AからBへの実線の矢印。コロンのあとがメッセージ

    ・B-->>A: メッセージ : 返答や完了通知は -->>(点線の矢印)で書く

    日本語名をそのままIDに使うこともできますが、矢印を書くたびに 顧客->>ECサイト: のように長くなるため、アルファベットのID+asの書き方がお勧めです。

    シーケンス図のレンダリング結果
    シーケンス図のレンダリング結果

    ガントチャートの書き方

    スケジュール管理でおなじみのガントチャートも、テキストだけで書けます。

    gantt
        dateFormat YYYY-MM-DD
        axisFormat %m/%d
        title Webサイトリニューアル
        section 企画フェーズ
            要件定義   :2026-08-03, 7d
            仕様書作成 :7d
        section 制作フェーズ
            デザイン   :10d
            実装       :14d

    ・dateFormat : 日付の書き方の指定。YYYY-MM-DD が最も一般的

    ・axisFormat : 横軸の日付表示。%m/%d で「08/03」のような月/日形式になる

    ・section : フェーズの区切り

    ・タスクは「タスク名 : 開始日, 期間」の形式。最初のタスクだけ開始日を指定すれば、以降は前のタスクの終了日から自動で始まります

    ガントチャートのレンダリング結果
    ガントチャートのレンダリング結果

    AIにMermaidを書かせる方法|プロンプト例つき

    ここまで基本文法を紹介してきましたが、実はすべて暗記する必要はありません。生成AIにMermaidのコードを書かせることができるからです。

    プロンプト(AIへの依頼文)の型はこちらです。

    〇〇のフローをMermaidのflowchart TD形式で書いてください。

    ポイントは2点です。

    1. 「Mermaid」という名前を明示する

    2. 「flowchart TD」のように形式を指定する

    具体例として、経費申請のフローを依頼するプロンプトはこのようになります。

    社内の経費申請から承認までのフローをMermaidのflowchart TD形式で書いてください。
    流れは、
    申請者が申請→上長が内容確認→承認か却下かで分岐→承認の場合は経理部門へ送付→処理完了→申請者へ通知、
    却下の場合は申請者へ差し戻し、です。

    上記のプロンプトをChatGPTに依頼した結果が以下となります。ChatGPT上ですでにマーメイドの図を表示してくれています。

    ChatGPTがMermaidの図を表示した画面
    ChatGPTがMermaidの図を表示した画面

    AIの出力は「叩き台」。3つのポイントを確認しよう

    ただし、AIの出力が常に完璧とは限りません。出力されたコードをmermaid.liveに貼り付けて、次の3点を確認しましょう。

    1. 形式が正しいか: コードが flowchart TD で始まっているか

    2. テキストが意図通りか: AIは「申請者が経費申請書を提出する」のように長い表現を使いがち。「経費申請」のように短くすると図が読みやすくなる

    3. 条件分岐のつながりが正しいか: AIが「承認」「却下」の矢印の向きを逆にしてしまうことがある

    ここで、この記事で紹介した基本文法が活きてきます。Mermaidのコードが読めると、AIの出力を素早くチェックして、必要な箇所だけ直せるようになります。

    まとめ:Mermaidの書き方は「基本文法+AI」で身につけよう

    改めて、Mermaidの書き方のポイントをまとめます。

    1. 練習は無料のMermaid Live Editor(mermaid.live)で。左にコード、右にプレビュー

    2. フローチャートは flowchart TD で宣言し、[テキスト]・{分岐}・--> の3つで書ける

    3. シーケンス図は sequenceDiagram、ガントチャートは gantt で宣言する

    4. AIには「Mermaidのflowchart TD形式で」のように、名前と形式を指定して依頼する

    5. AIの出力は叩き台。基本文法を知っていれば、確認・修正が自分でできる

    テキストを書くだけで図が完成するMermaidは、生成AI時代にぴったりの図解スキルです。ぜひ今日からmermaid.liveで試してみてください。


    ※動画で体系的に学びたい方は、私のUdemy講座もご活用ください。フローチャートからレーダーチャートまで、図の種類ごとに「書き方+AIへの依頼方法」をセットで解説しています。

    仕事で使えるMermaid(マーメイド)入門 〜テキストから図を生み出す、生成AI時代の図解スキル〜

    → 講座の詳細はこちら

    ▽あわせて読みたい▽


     
     
    Udemy講師の栗原直樹です。 未学習者の方に向けた、分かりやすい解説が得意です。難しい内容でも、圧倒的に分かりやすく嚙み砕いてお伝えいたします。 【公式サイト】 https://kurihara-naoki.com/

    あなたへのおすすめ