信息来源:特络纳
详细设计说明书
1 引言
1.1编写目的
说明编写这份详细设计说明书的目的,指出预期的读者。
1.2背景
说明:
a.待开发软件系统的名称;
b.本项目的任务提出者、开发者、用户和运行该程序系统的计算中心。
1.3定义
列出本文件中用到专门术语的定义和外文首字母组词的原词组。
1.4参考资料
列出有关的参考资料,如:
a.本项目的经核准的计划任务书或合同、上级机关的批文;
b.属于本项目的其他已发表的文件;
c.本文件中各处引用到的文件资料,包括所要用到的软件开发标准。 列出这些文件的标题、文件编号、发表日期和出版单位,说明能够取得这些文件的来源。
2 程序系统的结构
用一系列图表列出本程序系统内的每个程序(包括每个模块和子程序)的名称、标识符和它们之间 的层次结构关系。
3 程序1(标识符)设计说明
从本章开始,逐个地给出各个层次中的每个程序的设计考虑。以下给出的提纲是针对一般情况的。 对于一个具体的模块,尤其是层次比较低的模块或子程序,其很多条目的内容往往与它所隶属的上一层 模块的对应条目的
内容相同,在这种情况下,只要简单地说明这一点即可。
3.1程序描述
给出对该程序的简要描述,主要说明安排设计本程序的目的意义,并且,还要说明本程序的特点(如 是常驻内存还是非常驻?是否子程序?是可重人的还是不可重人的?有无覆盖要求?是顺序处理还是并发 处理卜…..
等)。
3.2功能
说明该程序应具有的功能,可采用IPO图(即输入一处理一输出图)的形式。
3.3性能
说明对该程序的全部性能要求,包括对精度、灵活性和时间特性的要求。
3.4输人项
给出对每一个输入项的特性,包括名称、标识、数据的类型和格式、数据值的有效范围、输入的方式。 数量和频度、输入媒体、输入数据的来源和安全保密条件等等。
3. 5输出项
给出对每一个输出项的特性,包括名称、标识、数据的类型和格式,数据值的有效范围,输出的形式、 数量和频度,输出媒体、对输出图形及符号的说明、安全保密条件等等。
3.6算法
详细说明本程序所选用的算法,具体的计算公式和计算步骤。
3.7流程逻辑
用图表(例如流程图、判定表等)辅以必要的说明来表示本程序的逻辑流程。
3.8接口
用图的形式说明本程序所隶属的上一层模块及隶属于本程序的下一层模块、子程序,说明参数赋值和调用方式,说明与本程序相直接关联的数据结构(数据库、数据文卷)。
3.9存储分配
根据需要,说明本程序的存储分配。
3.10注释设计
说明准备在本程序中安排的注释,如:
a. 加在模块首部的注释;
b.加在各分枝点处的注释; 对各变量的功能、范围、缺省条件等所加的注释;
d.对使用的逻辑所加的注释等等。
3.11限制条件
说明本程序运行中所受到的限制条件。
3.12测试计划
说明对本程序进行单体测试的计划,包括对测试的技术要求、输入数据、预期结果、进度安排、人员职责、设备条件驱动程序及桩模块等的规定。
3.13尚未解决的问题
说明在本程序的设计中尚未解决而设计者认为在软件完成之前应解决的问题。
4 程序2(标识符)设计说明
用类似3的方式,说明第2个程序乃至第N个程序的设计考虑。
(借花献佛)
///////////////////////////////////////////////////////////////////////////
1 引言
1.1 参考资料
1.2 关键字
2 全局设计
2.1 软件结构
/*说明软件的模块结构、目录和程序清单*/
2.2 概述
/*说明对公共输入输出项目处理的功能性能要求,包括数据的增删改、查询、统计、打印等*/
2.3 子系统界面设计
/*说明各个用户主要界面的设计(一些屏幕项)既涉及的各个事件的作用*/
2.4 外部关系和接口
/*确定模块的公共构件,定义公共构件的接口、实现和算法,并表示出其处理过程*/
2.5 数据描述
/*说明公共用到的表以及引用的其他模块的数据表*/
2.6 出错设计
/*出错处理信息:对常见的系统出错和用户操作出错,规定出错处理代码、处理方法和用户提示信息;对不可恢复的重要操作,规定用户确认处理
出错处理对策:如设置后备、性能降级、恢复和再启动等*/
3 模块设计
3.1 xxx模块
3.1.1 模块结构及模块内部处理流程
/*工具表示算法合内部流程的处理过程,完成模块的详细过程描述,将概要设计产生的模块细化成若干用图表表示的可编程的程序单元*/
3.1.2 用户界面与模块关系
/*设计每个子系统的所有用户界面,包括菜单、对话框、窗体等,还要给出这些用户界面的运行序列,形成用户界面的原型,预演软件系统的运行模式*/
3.1.3 数据需求规定
/*不模块内的主要输入输出项目、处理的功能性能要求及局部、全局数据和重要变量/
3.1.4 数据库存取
/*说明本模块用到的表以及引用其他模块的数据*/
3.1.5 主要算法
/*说明主要的算法和公式*/
3.1.6 调用程序及公用函数
3.1.7 程序设计
4 测试要点
/*常见错误、易出错地方、可靠性要点、侧使用例等*/
4.1 程序代码检查
4.1.1 程序首部有程序说明和修改备注(编写/修改人、时间、功能及调用关系等)
4.1.2 变量、过程、函数应符合统一的命名规则
4.1.3 程序不同功能部分有说明,较复杂的地方也有说明
4.1.4 修改的代码出有修改注释,说明修改人、时间和内容
4.1.5 确认录入数据的值范围,数据提交成功与否,提交失败需事务回滚
4.2 界面及报表格式检查
4.2.1 界面、报表的格式及程序命名符合约定
4.2.2 界面、报表的字段位置、长度、类型与设计文档的要求一致
4.3 功能测试
4.3.1 多个界面之间的切换正确
4.3.2 界面的功能键、出发键、按钮、菜单、选择项功能正确
4.3.3 数据项的关联和限制功能是否正确
4.4 正确性测试
4.4.1 结合数据库表检查写/删除操作的结果是否正确
4.4.2 结合数据库表检查查询/报表的数据是否正确
4.4.3 对照设计文档的要求,测试程序是否正确
4.5 可靠性测试
4.5.1 非法键容错测试,在不同界面不同字段键入非法键,程序应有非法键容错能力
4.5.2 异常数据容错测试,在不同界面不同字段键入异常数据,程序应有异常数据容错能力
4.5.3 程序副作用测试,推出程序后应恢复到进入前的状态,不应影响其他程序的正常运行
4.5.4 残留文件检查。
4.6 执行效率测试
4.6.1 测试页面转换等操作的时间延迟
4.6.2 测试查询条件不同(多少)的结果返回时间
4.6.3 评价程序的执行效率
4.7 测试用例说明
4.7.1 测试用例的具体描述:用例名称、用例目的、测试步骤、用例输入、期待输出、实际输出
4.7.2 回归测试的具体描述(同上)