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

Question

大多数（如果不是所有）我见过（和开发）的架构文档都以一系列视图（逻辑、物理、用例等）的形式呈现。这是首选布局吗？还有哪些其他款式？

Answer 1

由于它很复杂，否则很难做到。

我喜欢从总体要求的单段摘要开始。如果没有一个段落摘要，那可能是最重要的构建。

一旦总结出来，就会有架构特性的概述。在那之后，没有人会读一个字。

这不是小说。没有故事情节。没有剧情。没有冲突。没有字符。至少，我找不到使架构可读的方法。

您可以期望的最好的参考作品是具有足够的索引、交叉引用、概述和侧边栏供人们使用的参考作品。

事实上，重要的是拉出。图片是所有任何人都会使用的。这些将被放入PPT中，用于内部和外部演示。

所以，不要在写作上浪费太多时间。将时间花在人们每天想要使用的概述、摘要、功能列表和图片上。

Answer 2

这可能是题外话，但无论如何使用Joel 的想法来使规范“有趣”可用是这个领域吗？