软件文档写作教程第十一章

软件文档写作教程
马平
北京航空航天大学软件学院
11.详细设计书案例分析二
❖ 中国教育信息化系统案例分析
❖ 11.1 案例分析 ❖ 11.2 详细设计的工具 ❖ 11.3 详细设计书的注意事项 ❖ 11.4 详细设计的评审
11.1 案例分析
❖ 《中国教育信息化系统》经过概要设计阶段之后，得出本系 统的功能划分，包括五大功能：用户注册、用户登录、用户 信息管理、系统管理和检索功能。
❖ 判定树又称决策树，是一种用来表示逻辑判断问题的图形工 具，适合描述问题处理中具有多个判断，而且每个决策与若 干条件有关。
❖ 判定树与判定表比较，判定表虽然能清晰地表示复杂的条件 组合与应做的动作之间的对应关系，但其含义却不是一眼就 能看出来的，在直观程度上判定树优于判定表。
11.2.3 过程设计语言
❖ 本章以检索功能为例子，讲述如何进行详细设计以及在详细 设计书的书写过程中应该注意的地方。
11.1 案例分析
11.1 案例分析
11.1 案例分析
11.1 案例分析
ห้องสมุดไป่ตู้ 11.2 详细设计的工具
❖ 11.2.2 判定表 ❖ 11.2.3 判定树 ❖ 11.2.3 过程设计语言
11.2.2 判定表
应关系时，不如判定表清晰简单。
11.3 详细设计书的注意事项
❖ 11.3.1 详细设计书的划分 ❖ 11.3.2 详细设计书的命名 ❖ 11.3.3 详细设计书的细致程度
11.3.1 详细设计书的划分
❖ 详细设计书的划分应该和功能模块的划分一致。
❖ 但这个划分也不是绝对的，当有些功能相关性很强的时候， 它们的详细设计往往被写在同一份文件中。
11.3.3 详细设计书的细致程度
❖ 我们希望设计师们能在详细设计阶段结束的时候给出第二种 详细设计书，这样下一步的编码工作无论交给谁都能准确无 误地完成，甚至可以外包给第三方进行开发。
❖ 对于第一种设计书，只有设计者和编码者是同一人的情况下 才能实现详细设计到编码的过渡，否则编程人员很难根据这 样的详细设计书展开编码工作。
11.4 详细设计的评审
❖ 详细设计的评审，是确保该功能模块正确地实现了既定要求 的重要手段，也是优化算法的一个方法，更是保证软件质量 的有力武器。
❖ 评审（Peer Review）包括下面几种： ❖ 检视（Inspection） ❖ 团队评审（Team Review/Technical Review） ❖ 走读（WalkThough） ❖ 成对编程（Pair Programming） ❖ 同行检查（Peer DeskCheck） ❖ 特别检查（Ad hoc Review）
❖ 详细设计书的划分单位应该参考功能的划分又不局限于功能 的划分。
11.3.2 详细设计书的命名
❖ 比较好的详细设计书的命名方法可以采用: 功能模块的编号+功能名称。
11.3.3 详细设计书的细致程度
❖ 有的详细设计书大致描写了程序的流程但不是十分具体详细， 只是概述，也会略包含点业务；
❖ 在另一些详细设计书中，将程序流程写的十分详细具体，只 要将这些自然语言描述的处理过程转化为相关的编程语言就 能完成本功能模块的编码工作。
❖ 有一类问题，它的关连条件多，不同的条件组合在一起会产 生不同的结果，当条件多到一定程度的时候，用语言来描述 就显得杂乱无章而且很难理解，可用判定表来描述该问题。
❖ 判定表能够简洁而无歧异的描述处理规则，并且可以利用布 尔代数的方法对判定表进行简化，从而得出最本质的处理规 则。
11.2.3 判定树
❖ 过程设计语言(Process Design Language,简称PDL)，也 称程序描述语言(Program Description Language)，又称 为伪码。
❖ 它不像某种具体的编程语言具有自己的语法定义，但是它往 往会利用某种编程语言的关键字来帮助表达设计内容，而且 所利用的关键字会随着项目的不同而不同。
小结
❖ 本章以《中国教育信息化系统》为案例, 以检索功能为例子， 讲述了如何进行详细设计。还介绍了详细设计的主要工具以 及在详细设计书的书写过程中应该注意的地方。
❖ 详细设计是编码前的最后一个设计阶段, 要为编码提供非常 详细和正确的信息, 使后续的编码工作就如同翻译一样, 只要 将详细设计书里记载的有关信息正确翻译成为计算机语言就 可以了。
11.2.3 过程设计语言
❖ PDL的优点： I、可作为注释直接插在源程序中间。有助于保持文档和程 序的一致性，提高文档的质量。
❖ II、可使用普通的正文编辑程序或文字处理系统，很方便地 完成PDL的书写和编辑工作。
❖ III、已有自动处理程序存在，而且可自动由PDL生成程序代 码。
❖ PDL的缺点: ❖ 不如图形工具形象直观，描述复杂的条件组合与动作间的对