language-agnostic - 一連のビュー以外に、アーキテクチャドキュメントを提示するにはどうすればよいでしょうか。

Question

私が見た (そして開発した) アーキテクチャドキュメントのすべてではないにしても、ほとんどは一連のビュー (論理、物理、ユースケースなど) として提示されています。これは好ましいレイアウトですか？他にどんなスタイルがありますか？

score 2 · Accepted Answer

複雑なため、それ以外の方法で行うのは困難です。

全体的な要件の 1 段落の要約から始めたいと思います。1 段落の要約がない場合は、それが -- おそらく -- 作成する最も重要なものです。

要約が途切れたら、アーキテクチャー機能の概要があります。その後、誰も一言も読まなくなります。

それは小説ではありません。ストーリーアークはありません。ドラマはありません。競合はありません。文字がありません。少なくとも、アーキテクチャを読みやすくする方法が見つかりません。

あなたが望むことができる最善のことは、人々がそれを使用するのに十分な索引、相互参照、概要、サイドバーを備えた参考書です.

確かに、重要なのは引き出しです。写真は、誰もが使用するすべてです。そして、それらは社内外でのプレゼンテーションのために PPT に入れられます。

だから、書くことに多くの時間を無駄にしないでください。概要、要約、機能リスト、および人々が毎日使用したい写真に時間を費やしてください。

score 0 · Accepted Answer

language-agnostic - 一連のビュー以外に、アーキテクチャ ドキュメントを提示するにはどうすればよいでしょうか。