Xの投稿でmermaid記法なるものを知ったので勉強してみました。
Mermaidとは
Mermaid(マーメイド)は、テキストベースの記法を用いてさまざまな図を生成するためのツールです。Markdownに似たシンプルな構文で、フローチャート、シーケンス図、クラス図などを簡単に作成でき、コードの形で図を記述することができます。GitHubやGitLabなど多くのプラットフォームでサポートされています。
Mermaidを覚えて何がしたいか
Mermaidはさまざまなプラットフォームでサポートされているため、記述方法を覚えれば多くの場面で使えそうだと思いました。私の職場ではアトラシアン社のConfluenceを使ってドキュメントを残していますが、そこの中にあるdraw.ioという作図ツールでもMermaidがインポート出来そうだったので、作図のスピードを上げて業務効率化を図ることを目標にしました。
Mermaidで描ける図について
Mermaidで描ける図については公式サイトを見る限りざっと以下
- シーケンス図
- クラス図
- フローチャート
