ソフトウェアアーキテクチャ図を描く方法（2022）

• 効果的なソフトウェアアーキテクチャ図の描き方に関する記事
• 著者はソフトウェア開発における図の重要性を強調しており、議論や意思決定の中心になることが多いと述べている
• 図の内容は正確で、最新で、曖昧さがなく、エンティティと関係が正確に表現されていなければならない
• 著者は効果的な図のいくつかの特性を提案している:
  • 隣接距離の最小化: 関連するノード同士を近くに保つと、図を理解しやすくなる。図が大きくなるほど、これは難しくなる
  • 対称性を見つける: 対称的な図は見た目にも魅力的で理解しやすい。また、図が伝える意味を強化できる
  • 中央揃え: 整然として配置が揃った図は概念を明確にする。新しい要素を追加するたびに配置を保てば、図はすっきりする
  • コンテナグループの使用: 図を複数のラベル付き領域に分けると理解しやすくなる。コンテナは文脈を追加したり、抽象化を示したり、関連するオブジェクトをグループ化したりできる
• 著者は第2部で、線の経路の描き方、ラベルのサイズと位置、色、アイコンなどについてさらに扱うと予告している
• この記事は、ソフトウェアエンジニアや開発者向けの資料を提供するTerrastructブログの一部である

[GN⁺]

Hacker Newsの意見

• あるユーザーは、D2言語の書式オプションと構文のおかげでダイアグラム生成を楽しんでおり、これについてブログ記事を書いた。
• VisualFlows.ioは、ユーザーが数分以内に自分のSaaSのアニメーションアーキテクチャマップを設計できるv1.0をまもなくリリースする予定である。主な機能には、Smart Sections、Smart Edges、Smart Node Deletion、Dark/Light modes、Embeddable、Drag n Drop images/svgs/gifs、AWS/Windows/Google Icons、そしてMarkdownサポートがある。
• 別のユーザーは、システムが変化し始めると「美しい」ダイアグラムを維持するのは難しい場合があると主張し、より効率的な代替案として diagrams-as-code を使うことを提案している。
• あるユーザーは、大規模言語モデルには可能性がある一方で、ブロックと矢印を並べ替えて美しさを実現するローカルツールがないことへの不満を表明している。ユーザーが箱と矢印を描けば、ツールがすべてを整列させてきれいに見せてくれるようなものが、なぜ存在しないのかと疑問を呈している。
• あるユーザーは、ソフトウェアアーキテクチャ図と電気回路図、回路ダイアグラム、そして他のエンジニアリング図面との間に類似性を見いだしている。彼らは「正解」というものはなく、良い抽象化と表現方法を選ぶことが、後悔を招く混乱と理解可能なアイデアを分けることだと主張している。
• あるユーザーは、yEdを使ってダイアグラムを描いた経験を共有している。このツールでは箱と矢印をめちゃくちゃに配置できるが、メニューを数回クリックすれば自動的に整理される。
• あるユーザーは、実用的な方法で何かをより美しくする方法を説明した記事に感謝を伝えている。彼らは普段、たいてい感覚に頼っている。
• あるユーザーは、serverless.ymlファイルから大きなD2ダイアグラムを自動生成した経験を共有している。このツールは、システムの成長に合わせて自動的に更新される。
• 別のユーザーは、自身のブログ記事にD2言語を追加し、サイバーセキュリティ設計コードに関するトピックを扱っている。
• あるユーザーは、Markdown文書で書かれたプロジェクトにダイアグラムを挿入するために plantuml ブロックを追加することを提案している。GitLabでは .md ファイルをWebブラウザで開くと適切にレンダリングされるが、GitHubにはまだその機能がないと指摘している。