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

时间:2008-10-07 12:34:49

标签: language-agnostic architecture

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

2 个答案:

答案 0 :(得分:2)

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

我想从总体要求的一段摘要开始。如果没有一个段落的摘要,那可能是 - 最重要的事情。

摘要摘要完成后,会对架构功能进行概述。在那之后,没有人会读一个单词。

这不是小说。没有故事弧。没有戏剧性。没有冲突。没有人物。至少,我找不到一种方法来使架构可读。

您可以期待的最好的是具有足够索引,交叉引用,概述和人们使用它的侧边栏的参考工作。

事实上,重要的是拉出。图片是任何人都会使用的。这些将被纳入PPT的内部和外部演示。

所以,不要在写作上浪费大量时间。投入时间观看人们希望每天使用的概述,摘要,功能列表和图片。

答案 1 :(得分:0)

这可能是偏离主题的,但无论如何使用Joel's ideas on making specifications 'fun'可以使用这个领域吗?