大多数(如果不是所有)我见过(和开发)的架构文档都以一系列 View (逻辑、物理、用例等)的形式呈现。这是首选布局吗？还有哪些款式？
最佳答案
由于它很复杂，否则很难做到。
我喜欢从总体要求的一段总结开始。如果没有单段摘要，那可能是最重要的构建内容。
一旦总结出来，就会有架构特征的概述。在那之后，没有人会读一个字。
这不是小说。没有故事情节。没有戏剧性。没有冲突。没有字符。至少，我找不到使架构可读的方法。
您所能希望的最好的引用作品是具有足够索引、交叉引用、概述和侧边栏供人们使用的引用作品。
事实上，重要的是拉出。图片是任何人都会使用的。这些将被放入 PPT 中，用于内部和外部的演示。
所以，不要在写作上浪费太多时间。花时间在人们每天想要使用的概述、摘要、功能列表和图片上。
关于language-agnostic - 除了作为一系列 View 之外，还可以如何呈现架构文档？，我们在Stack Overflow上找到一个类似的问题：https://stackoverflow.com/questions/178231/