知识卡片
渐进式文档创建策略
内容
面对”如何向新人传达设计”这类没有单一明确解法的风险,可按成本从低到高逐步添加文档,每加一部分就重新评估风险是否已缓解,用”三个主要模型+三种视图类型”的覆盖率作为进度尺度:先给模块模型(成本最低),再给质量属性优先级和设计决策说明(代码里看不出的取舍原因),再给运行时职责列表和功能场景,部署视图因显而易见可跳过。覆盖主要模型和视图类型就可停止,不必面面俱到。
参考来源
- 位置:《恰如其分的软件架构》第4章《实例:家庭媒体播放器》4.1节《团队沟通》、4.1.5节《反思》(源文件:_epub-src/OEBPS/text00043.html)
- 结论依据:原文描述团队按模块模型→质量属性与设计决策→运行时模型的顺序逐步添加文档,每次都用视图类型与模型的覆盖率重新评估沟通风险是否缓解,一旦覆盖主要模型和视图类型就停止。
- 原始内容:我们可以先从代价小的技术开始,然后再选择成本较高的技术,直到认为风险已然消除为止……我们可以先从创建最为简单的文档开始,然后逐渐添加那些更有价值的内容……一旦我们覆盖了主要的模型和视图类型,就可以暂告一个段落。