💯

図表を書くならMermaid

に公開

はじめに

システム設計やドキュメント作成において、図表は欠かせない存在です。しかし、パワーポイントなどのツールで図を作成すると、配置の調整に時間を取られたり、仕様変更のたびに大幅な修正が必要になったりと、悩みは尽きません。
そこで役に立つのがMermaidです。

Mermaidとは

Mermaidはテキストベースで図表を記述できるツールで、コードを書くように図を作成できます。
https://mermaid.js.org/
https://help.docbase.io/posts/3719897

変更に強い

最大の魅力は変更に強いことです。
要素を追加・削除してもレイアウトは自動で整うため、仕様変更があっても素早く対応できます。

様々なプラットフォームで使える

また、NotionやGitHub、Google Docs(拡張機能を使えば)など様々なプラットフォームで使えるのも大きな利点です。パワーポイントを立ち上げる必要もなく、ドキュメントに直接埋め込めるため、情報の一元管理が可能になります。

センスがなくても美しい図が作れる

これまでに見るに堪えない図を見たことや作ってしまった経験はありませんか。
Mermaidは自動的にバランスの取れた美しい図を生成してくれます。

生成AIで作れる

ドキュメントを渡せば、割と正確な図ができます。
あとは少し修正してあげるだけでめんどくさい図の作成ができます~素晴らしい。

C4モデルとの相性が抜群

特にC4モデルと組み合わせることで、システムアーキテクチャを適切な抽象度で視覚化でき、技術的な説明がぐっと分かりやすくなります。
日本ではあまり有名ではなさそうですが、図も頭も整理される素晴らしいモデルだと思います。
https://c4model.com/

バージョン管理との相性も◎

テキストで管理できるため、バージョン管理システムとの相性も抜群。

おわりに

チーム開発における図表管理として、とても便利なのでぜひ試してみてください。
チーム全体で使えるようになると恩恵が大きくなりそうです!

Discussion