除了作为一系列视图之外，还能如何呈现架构文档？

Question

大部分（如果不是所有）我见过（和开发）的体系结构文档都是作为一系列视图（逻辑，物理，用例等）呈现的。这是首选布局？还有什么其他风格？

Answer 1

既然它很复杂，否则很难做到。

我喜欢从总体要求的一段总结开始。如果没有一个段落的摘要，那也许是最重要的一点。

一旦总结不成，就会有一个关于建筑特征的概述。之后，没有人会读一个单词。

它不是小说。没有故事的弧线。没有戏剧。没有冲突。没有字符。至少，我找不到让架构可读的方法。

您可以期待的最好的方法是使用足够的索引，交叉引用，概述和侧栏，以供人们使用它。

事实上，这是拉扯重要的。这张照片是所有人都会用到的。那些将被放入PPT中用于内部和外部的呈现。

所以，不要浪费很多时间写作。将时间投入到人们想要每天使用的概述，摘要，功能列表和图片中。

Answer 2

这可能是关闭的话题，但反正有使用Joel's ideas on making specifications 'fun'可用的是这个领域？