【要約】AWSの"俯瞰"構成図を自動生成する ── 見やすさを機械チェックしながら量産した話 [Qiita_Trend] | Summary by TechDistill
> Source: Qiita_Trend
Execute Primary Source
// Problem
提案や要件定義を行うエンジニアが、既存の自動生成ツールを用いてAWS構成図を作成しようとした際、以下の課題に直面した。
- ・既存ツールは実装詳細の記述に最適化されており、全体像を伝える俯瞰図としては情報密度が高すぎる。
- ・色や線が「サービスの分類」を表すために使われており、本来追うべき「データの流れ」を阻害している。
- ・図の「見やすさ」を客観的に評価する基準がなく、作成者の感覚に依存している。
- ・線の重なりやノードの貫通といった、視認性を損なう要素を検知する仕組みがない。
// Approach
著者は、用途に最適化された俯瞰図を量産するため、独自の描画エンジンと品質チェック機構を開発した。
- ・色と線を「データの流れ」の表現に限定し、分類は配置や注釈で行う設計指針を策定した。
- ・構成データ（NODES, WIRES）と描画ロジックを分離し、HTML/SVG形式で実装した。
- ・「線の重なり」「凡例との被り」「ノードの横断」「枠の貫通」の4観点で機械チェックを行う機能を実装した。
- ・Chrome headlessを用いて、描画結果をコマンドラインから自動検証できる仕組みを構築した。
// Result
この仕組みを導入したことで、エンジニアは視認性の高い構成図を効率的に量産できるようになった。
- ・4つのチェック観点をすべて0にすることで、初見でも流れが理解できる図を担保した。
- ・設計判断を線ではなく注釈に逃がすことで、線の本数を抑えつつ情報量を維持した。
- ・「見やすさ」の検証を自動化したことで、作図の締め作業における人的ミスを削減した。
- ・属人的な「図の良し悪し」の判断を、エンジニアリングによる品質管理へと昇華させた。
Senior Engineer Insight
> 図の品質を「感覚」ではなく「Lint」の概念で捉えた点が秀逸だ。大規模プロジェクトではドキュメントの品質にバラつきが出る。これをエンジニアリングで解決する姿勢は、運用コスト削減の観点からも高く評価できる。ただし、設計の論理的整合性は機械では判定できない。ツールはあくまで「伝わりやすさ」の補助と割り切るべきだ。