1
3

Delete article

Deleted articles cannot be recovered.

Draft of this article would be also deleted.

Are you sure you want to delete this article?

Mermaidで図表作成を楽しもう!

Last updated at Posted at 2024-09-18

はじめに

皆さん、こんにちは。今日は「Mermaid」というすばらしいチャートツールについてお話しします。Mermaidを使えば、複雑な図表やダイアグラムを簡単に作成できるんです。しかも、特別なソフトウェアは必要ありません。テキストエディタさえあれば十分です。

それでは、Mermaidの世界に飛び込んでみましょう!

第1章:Mermaidとは

Mermaidは、テキストベースの図表作成ツールです。簡単な記法を使って、フローチャート、シーケンス図、ガントチャートなど、さまざまな種類の図表を作ることができます。

Mermaidの特徴は以下の通りです:

  • テキストベース:図表をコードで表現
  • 多様な図表:フローチャート、シーケンス図、ガントチャートなど
  • 簡単な記法:短時間で習得可能
  • 高い再現性:コードを共有すれば、誰でも同じ図表を作成可能

第2章:Mermaidの基本構文

Mermaidの基本構文は非常にシンプルです。以下の形式で記述します:

graph TD
    A[開始] --> B[処理1]
    B --> C[処理2]
    C --> D[終了]

このコードは、上から下に向かうフローチャートを作成します。各ノードはアルファベットで表し、矢印(-->)でつなぎます。

第3章:フローチャートの作成

フローチャートは、Mermaidの代表的な図表の一つです。プロセスの流れを視覚化するのに最適です。

graph LR
    A[朝起きる] --> B{お腹すいた?}
    B -- はい --> C[朝食を食べる]
    B -- いいえ --> D[仕事を始める]
    C --> D
    D --> E[昼休み]

このコードでは、左から右(LR)に向かうフローチャートを作成しています。{}を使って判断を表現し、--で条件分岐を示しています。

第4章:シーケンス図の作成

シーケンス図は、システム間の相互作用を表現するのに適しています。

sequenceDiagram
    participant ユーザー
    participant サーバー
    participant データベース

    ユーザー->>サーバー: ログインリクエスト
    サーバー->>データベース: ユーザー情報照会
    データベース-->>サーバー: ユーザー情報返却
    サーバー-->>ユーザー: ログイン結果

このコードでは、sequenceDiagramを使ってシーケンス図を開始し、participantで登場人物(システム)を定義しています。->>-->> で矢印の種類を変えることができます。

第5章:ガントチャートの作成

プロジェクト管理に欠かせないガントチャートも、Mermaidで簡単に作成できます。

gantt
    title プロジェクトスケジュール
    dateFormat  YYYY-MM-DD
    section 企画フェーズ
    要件定義           :a1, 2023-01-01, 30d
    設計               :after a1, 20d
    section 開発フェーズ
    コーディング       :2023-02-20, 45d
    テスト             :2023-04-05, 20d
    section リリースフェーズ
    最終確認           :2023-04-25, 5d
    リリース           :2023-04-30, 1d

ganttでガントチャートを開始し、titleでタイトルを設定します。dateFormatで日付の形式を指定し、sectionで各フェーズを区切ります。タスクの期間は、開始日と期間(または終了日)で指定します。

第6章:クラス図の作成

オブジェクト指向プログラミングのクラス構造を表現するのに便利なクラス図も作成できます。

classDiagram
    class 動物 {
        +名前: string
        +年齢: int
        +鳴く(): void
    }
    class 犬 {
        +種類: string
        +吠える(): void
    }
    class 猫 {
        +毛色: string
        +ニャーと鳴く(): void
    }
    動物 <|-- 犬
    動物 <|-- 猫

classDiagramでクラス図を開始し、classキーワードで各クラスを定義します。<|--で継承関係を表現できます。

第7章:状態遷移図の作成

システムの状態変化を表現する状態遷移図も、Mermaidで簡単に作成できます。

stateDiagram-v2
    [*] --> 待機中
    待機中 --> 実行中: 開始ボタン押下
    実行中 --> 一時停止: 一時停止ボタン押下
    一時停止 --> 実行中: 再開ボタン押下
    実行中 --> 完了: タスク完了
    完了 --> [*]

stateDiagram-v2で状態遷移図を開始します。[*]は開始と終了を表し、-->で状態間の遷移を示します。コロン(:)の後に遷移の条件を記述できます。

第8章:円グラフの作成

データの割合を視覚的に表現する円グラフも、Mermaidで作成可能です。

pie title 好きな果物の割合
    "りんご" : 40
    "バナナ" : 30
    "オレンジ" : 20
    "ぶどう" : 10

pieキーワードで円グラフを開始し、titleでタイトルを設定します。各項目とその値をコロン(:)で区切って記述します。

第9章:ER図の作成

データベース設計で使用されるER図(実体関連図)も、Mermaidで表現できます。

erDiagramでER図を開始します。エンティティ間の関係を||--o{のような記号で表現し、各エンティティの属性を{}内に記述します。

第10章:ユーザージャーニーマップの作成

ユーザーの行動や体験を可視化するユーザージャーニーマップも、Mermaidで作成できます。

journey
    title ウェブサイトでの商品購入
    section 商品検索
      商品を探す: 5: ユーザー
      商品詳細を確認: 3: ユーザー
    section カート操作
      カートに追加: 4: ユーザー
      カートを確認: 5: ユーザー
    section 注文処理
      配送先入力: 3: ユーザー
      支払い方法選択: 4: ユーザー
      注文確定: 5: ユーザー

journeyキーワードでユーザージャーニーマップを開始し、titleでタイトルを設定します。sectionで各段階を区切り、各ステップとその満足度(1-5)を記述します。

第11章:タイムライン図の作成

イベントの時系列を視覚化するタイムライン図も、Mermaidで簡単に作成できます。

timeline
    title 会社の歴史
    2010 : 会社設立
    2012 : 最初の製品リリース
    2015 : 海外進出開始
    2018 : 上場
    2020 : 新本社ビル完成
    2023 : 年間売上1000億円達成

timelineキーワードでタイムライン図を開始し、titleでタイトルを設定します。各イベントを年(または日付)とコロン(:)で区切って記述します。

第12章:マインドマップの作成

アイデアやコンセプトを整理するマインドマップも、Mermaidで表現できます。

mindmap
  root((健康的な生活))
    食事
      バランスの良い食事
      十分な水分摂取
      適度な間食
    運動
      有酸素運動
      筋力トレーニング
      ストレッチ
    睡眠
      規則正しい就寝時間
      快適な睡眠環境
    メンタルヘルス
      ストレス管理
      趣味の時間
      社会的つながり

mindmapキーワードでマインドマップを開始します。中心となる概念をroot(())で表し、サブトピックをインデントで表現します。

第13章:ネットワーク図の作成

ネットワークトポロジーを表現するネットワーク図も、Mermaidで作成可能です。

graph TB
    インターネット((インターネット))
    ファイアウォール{ファイアウォール}
    ルーター[ルーター]
    スイッチ[スイッチ]
    サーバー1[Webサーバー]
    サーバー2[データベースサーバー]
    PC1[クライアントPC1]
    PC2[クライアントPC2]

    インターネット --- ファイアウォール
    ファイアウォール --- ルーター
    ルーター --- スイッチ
    スイッチ --- サーバー1
    スイッチ --- サーバー2
    スイッチ --- PC1
    スイッチ --- PC2

graph TB(上から下)でネットワーク図を開始します。各ネットワーク機器を適切な形状([], {}, (())など)で表現し、---で接続関係を示します。

第14章:gitグラフの作成

gitのブランチやコミット履歴を可視化するgitグラフも、Mermaidで作成できます。

gitGraph
    commit
    branch develop
    checkout develop
    commit
    commit
    checkout main
    merge develop
    commit
    branch feature
    checkout feature
    commit
    commit
    checkout develop
    merge feature
    commit
    checkout main
    merge develop
    commit

gitGraphキーワードでgitグラフを開始します。commitでコミットを、branchで新しいブランチを作成し、checkoutでブランチを切り替え、mergeでマージを表現します。

このように、Mermaidを使いこなすことで、複雑な概念や処理を分かりやすく視覚化することができます。

今後、Mermaidはさらに機能が拡張され、より多様な図表やダイアグラムの作成が可能になると期待されています。また、AIとの連携により、自然言語による図表生成なども実現されるかもしれません。

Mermaidは、プログラマーだけでなく、ビジネスアナリスト、プロジェクトマネージャー、教育者など、幅広い分野の人々にとって有用なツールとなっています。ぜひ、皆さんも日々の業務や学習にMermaidを活用してみてください。きっと、アイデアの整理や情報の共

1
3
0

Register as a new user and use Qiita more conveniently

  1. You get articles that match your needs
  2. You can efficiently read back useful information
  3. You can use dark theme
What you can do with signing up
1
3

Delete article

Deleted articles cannot be recovered.

Draft of this article would be also deleted.

Are you sure you want to delete this article?