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

Mermaid 入門 ― 図を書くからテキストで描くに

    kindleで初心者向けのわかりやすいものが出たので紹介です

    Mermaidには便利な機能がたくさんあります。しかし、初めて使う人にとっては、結局、最初に何を覚えればいいのか分からないという問題があります。

    この本では、初心者向けに豊富な例題をもいちてすぐに試せるコードが紹介されています。すべて、https://mermaid.liveでテスト済みのソースコード(マークダウン)と実行結果の図がのっています。

    そこで、この本では最初から難しい説明をするのではなく、

    コードを書く
    ↓
    実際に動かす
    ↓
    図を見る
    ↓
    少しコードを変更してみる

    という流れを重視しました。

    特に、Mermaidをまったく知らない人でも読み進められるように、基本的なところから始めています。

    フローチャートを作りたいけれど、図形を一つずつ配置するのは面倒だ

    設計書の図を修正するたびに、図全体を直すのが大変だ

    Mermaidという名前は聞いたことがあるけれど、実際には使ったことがない

    そんな方に向けて、Mermaid 入門 ― 図を書くからテキストで描くに ― をまとめました。

    Mermaidとは?

    Mermaidは、図を直接マウスで描くのではなく、テキストでコードを書いて図を作るためのツールです。

    たとえば、フローチャートなら、

    graph TD
        A[開始] --> B[処理]
        B --> C{条件}
        C -->|Yes| D[終了]
        C -->|No| B
    

    のようなテキストを書くだけで、フローチャートを作ることができます。

    画像

    図形をドラッグして配置する必要はありません。しかも、テキストのコードを変更すれば図もリアルタイムに変更されます。

    図を書くというより、図をプログラムすると考えると分かりやすいかもしれません。

    まずはMermaidを実際に動かしてみる

    本書では、最初にMermaid Live Editorを使ってMermaidを動かします。

    インストールや複雑な環境構築をする前に、ブラウザ上でコードを書いて、すぐに結果を見ることができます。

    その後、VSCode、GitHub、NotionなどでMermaidを利用する方法にも触れています。

    とりあえず動かしてみたいという方には、この方法が一番分かりやすいと思います。

    フローチャートから始める

    最初に取り上げるのは、Mermaidでよく使われるフローチャートです。

    ノードと矢印から始めて、

    • 条件分岐

    • ループ

    • グループ化

    • スタイルの変更

    • 業務フロー

    へと少しずつ進みます。

    すべての記法を最初から覚える必要はありません。

    例えば初心者なら、

    • [ ] 処理

    • { } 条件分岐

    • (( )) 開始・終了

    の3種類から覚えるだけでも、かなりのフローチャートを作ることができます。

    フローチャートだけではありません

    Mermaidで作れる図はフローチャートだけではありません。

    この本では、

    • フローチャート

    • シーケンス図

    • UML関連の図

    • クラス図

    • ER図

    • 状態遷移図

    • タイムライン

    • ガントチャート

    • 円グラフ

    • マインドマップ

    などを取り上げています。全部覚えなければいけないという本ではありません。必要になった図を、その都度この本で調べて使えるようにすることを意識しています。

    UMLについても取り上げています

    エンジニアにとって、UMLは避けて通れない場面があります。そこで本書でもUMLを取り上げています。ただし、ここには少し注意が必要です。

    MermaidとUMLは同じものではありません。

    MermaidにはUMLのすべての図に対応する専用構文があるわけではありません。そのため、本書ではUMLそのものを詳しく解説するのではなく、

    UMLで表現するような情報を、Mermaidではどのように表現できるのか

    という実用的な視点から説明しています。これはMermaidを使う上で、意外と重要なポイントだと思います。

    最後は、実際の開発ドキュメントを作っています

    本書の最後では、学んできた図を組み合わせて、架空のタスク管理WebアプリTaskeyの開発ドキュメントを作っています。ここでは、

    • システム構成

    • API通信

    • データベース設計

    • クラス構造

    • 状態管理

    • 開発・デプロイフロー

    • リリーススケジュール

    などを、それぞれ適したMermaidの図で表現します。

    ここまで来ると、Mermaidで図を作るということが、単なる練習ではなく、開発ドキュメントをテキストから作る、という使い方につながってきます。

    こんな方におすすめです

    この本は、特に次のような方を対象にしています。

    • Mermaidをまったく使ったことがない

    • Mermaidという名前は知っているが、使い方が分からない

    • フローチャートをテキストで作ってみたい

    • プログラムの設計図をテキストから作りたい

    • GitHubやMarkdownで図を使いたい

    • シーケンス図やER図を簡単に作りたい

    • UMLとMermaidの関係を知りたい

    • 開発ドキュメントにMermaidを使ってみたい

    逆に、すでにMermaidを使いこなしていて、すべての構文を知っている方には、少し物足りないかもしれません。

    これからMermaidを使ってみたい

    という方に向けた本です。

    本書の特徴

    コードを書いて、実際に図を確認する

    Mermaid Live Editorで実際にコードを動かしながら学びます。

    初心者向けに基本から説明

    いきなり複雑な記法を覚えるのではなく、簡単な例から始めます。

    さまざまな図を扱う

    フローチャートだけでなく、シーケンス図、クラス図、ER図、状態遷移図などへ進みます。

    最後は実践

    最後には、複数の図を組み合わせてWebアプリの開発ドキュメントを作ります。

    エラーにも触れる

    Mermaidでは、ちょっとしたスペルミスや全角文字などで図が表示されないことがあります。よくあるエラーと確認ポイントもまとめています。

    図を書くからテキストで描くへ

    Mermaidの面白さは、図を作ることそのものだけではありません。図をテキストとして管理できることで、

    修正しやすい
    共有しやすい
    再利用しやすい
    バージョン管理しやすい

    というメリットがあります。特にプログラムやMarkdownに慣れている人にとっては、従来の図を描くという方法とは違った感覚で設計図や説明図を作ることができます。

    図を作ることが苦手な人でも、コードを書くことに慣れているなら、Mermaidは意外と入りやすいかもしれません。

     
     
    現場視点でIT技術、教育、社会の課題を切り取る元ITエンジニアです。これまで何冊かの書籍を出版(Kindle Unlimited対象がほとんど)。30年のIT開発経験、外資ITコンサル、11年の専門学校教員(修士)の経歴を活かし、初心者にも本質が伝わる分かりやすい発信をします。

    あなたへのおすすめ