【要約】設計図の描き方入門：Mermaid記法とER図・シーケンス図・クラス図(UML)の基礎 [Qiita_Trend] | Summary by TechDistill
> Source: Qiita_Trend
Execute Primary Source
// Problem
設計者がシステムの構造や振る舞いを説明する際、文章のみでは複雑な関係性を正確に伝えられない課題に直面する。
- ・視覚情報の欠如：文章による説明は、データの多重度や時系列のメッセージフローを直感的に伝えることが難しい。
- ・管理コストの増大：従来の専用作図ツールは、GUI操作を前提とするため、Gitを用いた差分管理が困難である。
- ・ドキュメントの陳腐化：設計図がコードから分離して管理されることで、実装との乖離が生じ、情報の鮮度が失われる。
// Approach
設計の標準化とドキュメント管理の効率化を両立するため、UMLの概念とMermaidによるテキスト記述を組み合わせる。
- ・UMLの活用：実務で頻用されるER図、シーケンス図、クラス図の3種に絞って設計を標準化する。
- ・Mermaidによるテキスト化：図をコードとして記述し、Markdownファイル内に直接埋め込む。
- ・自動描画環境の利用：GitHubやGitLab等の対応環境を活用し、テキストを即座に視覚的な図として表示させる。
// Result
エンジニアは、設計図をソースコードと同様のワークフローで管理し、開発サイクルに組み込めるようになる。
- ・バージョン管理の実現：Gitを用いて設計変更の履歴を正確に追跡し、変更理由を明確にできる。
- ・ドキュメントの統合：Markdown内に図を保持することで、ドキュメントの散逸を防ぎ、情報の集約化を図れる。
- ・作成コストの低減：マウス操作を排し、テキスト入力のみで迅速に図を更新できるため、設計の鮮度を維持しやすい。
Senior Engineer Insight
> 設計の「コード化」は、ドキュメントの腐敗を防ぐために極めて重要だ。MermaidはGitとの親和性が高く、プルリクエストのレビュープロセスに設計変更を組み込める。これにより、実装と設計の乖離を最小限に抑えられる。ただし、極めて複雑な図はテキスト記述の負荷が高まるため、図の粒度を適切に保つ設計判断が求められる。