我所见过(和开发的)的大部分架构文档(如果不是所有的话)都是以一系列视图(逻辑、物理、用例等)的形式呈现的。这是首选布局吗?还有其他的风格吗?
发布于 2008-10-07 13:23:20
因为它很复杂,所以很难做其他事情。
我喜欢从总体需求的一段总结开始。如果没有一个段落的摘要,那可能是构建的最重要的东西。
一旦总结出来,就会有一个架构特性的概述。在那之后,没有人会读一个字。
这不是小说。没有故事弧线。没有戏剧性。没有冲突。没有字符。至少,我找不到让架构变得可读的方法。
你所能期望的最好的结果就是有足够的索引、交叉引用、概述和侧边栏供人们使用的参考书。
事实上,退出才是最重要的。这张照片是所有人都会用到的。这些将被放入PPT中,用于内部和外部演示。
所以,不要在写作上浪费太多时间。把时间花在概述、摘要、特写列表和人们每天想要使用的图片上。
发布于 2008-10-07 16:00:05
这可能是一个离题的话题,但是有没有使用Joel's ideas on making specifications 'fun'的可用的领域呢?
https://stackoverflow.com/questions/178231
复制相似问题