1、项目名称详细设计说明书版本号：X.X作者：批准人：日期:XXXX年XX月XX日XXXXXXXXXXXX 公司文档修订版本日期更改人描述（注明修改的条款或页）抄送人：项目经理、客户经理、客户代表、项目组成员、SCCB （在项目实际应 用时最好写明抄送人的姓名）XXXX-XX-XXX-XXXXXX 年 XX 月 XX Page 2 of 14目录1. 引言41.1 编写目的41.2 项目背景41.3 定义41.4 参考资料42. 设计流程43. 程序系统的结构43.1 程序清单43.2 服务/事务清单43.3 界面清单53.4 代码清单53.5 公用函数/类清单54. 程序1（标识符）设计说明64
2、.1 程序描述64.2 功能64.3 性能64.4 输人项64.5 输出项64.6 算法64.7 流程逻辑64.8 接口64.9 存储分配64.10 注释设计74.11 限制条件74.12 测试计划74.13 尚未解决的问题75. 程序2 （标识符）设计说明7附件1服务/事务清单8附件2程序清单8附件3代码清单9附件4公用函数/类清单9附件5程序设计105.1 程序设计1105.2 程序设计211附件6类设计11附件7函数设计（含成员函数）12附件8存储过程设计12附件9数据结构清单131. 引言1.1编写目的阐明编写详细设计说明书的目的，指明读者对象。1.2项目背景应包括项目的来源和主管部门
3、等。1.3定义列出文档中所用到的专门术语的定义和缩写词的原文。1.4参考资料列出有关资料的作者、标题、编号、发表日期、出版单位或资料来源，可包括:a. 需求规格说明书；b. 概要设计说明书；c. 文档中所引用的其他资料、软件开发标准或规范。2. 设计流程如给出软件系统的流程结构图。3. 程序系统的结构3.1程序清单程序清单列出所有最终运行程序格式见附2台头要描述清楚，其中编号见“命名规范”各栏的填写方法如下：编号：从1开始的递增序列，保证同一程序清单内没有重复程序名称：见“命名规范”，是最终实现的程序名称，并且应该与概要设 计中的模块编号基本一致。程序说明：简要介绍该程序的功能文件清单：列出实
4、现该程序的文件清单，包括重要的头文件、源码文件、 库文件、必须的目标文件等。3. 2服务/事务清单服务清单列出主机系统提供的所有事务、各节点所有的服务格式见附1各项目小组列出本组所有的服务清单后，统一按节点生成服务清单。各栏的填写方法如下：编号：项目组统一编制服务名称：见“命名规范”所属系统：为 HVPS、BEPS、SAPS、CCMS、PDMS、TRCS、公共服务、 接口服务之一相关程序：列出提供该服务的程序名（或清单）服务说明：简要介绍该服务3. 3界面清单格式及编制说明见“概要设计规范”3. 4代码清单代码清单列出所有源码文件格式见附3台头要描述清楚，其中编号见“命名规范”各栏的填写方法如
5、下：编号：从1开始的递增序列，保证同一代码清单内没有重复源程序名称：见“命名规范”，是最终实现的文件名称，包括文件后缀，并 且应该与概要设计中的模块编号基本一致。程序说明：简要介绍该程序的功能，并列出文件包括的公用函数。3.5公用函数/类清单公用函数/类清单列出所有的公用函数、公用类格式见附4台头要描述清楚，其中编号见“命名规范”各栏的填写方法如下：编号：从1开始的递增序列，保证同一清单内没有重复名称：公用函数名或公用类名。说明：简要介绍函数的功能，或者类的用途。4. 程序1 （标识符）设计说明从本章开始，逐个地给出各个层次中的每个程序的设计考虑。以下给出的 提纲是针对一般情况的。对于一个具体
6、的模块，尤其是层次比较低的模块或子程 序，其很多条目的内容往往与它所隶属的上一层模块的对应条目的内容相同， 在这种情况下，只要简单地说明这一点即可。4.1程序描述给出对该程序的简要描述，主要说明安排设计本程序的目的意义，并且， 还要说明本程序的特点（如是常驻内存还是非常驻？是否子程序？是可重入的 还是不可重入的？有无覆盖要求？是顺序处理还是并发处理等）。4.2功能说明该程序应具有的功能，可采用IPO图（即输入一处理一输出图）的形 式。4. 3性能说明对该程序的全部性能要求，包括对精度、灵活性和时间特性的要求。4. 4输人项给出对每一个输入项的特性，包括名称、标识、数据的类型和格式、 数据值的有
7、效范围、输入的方式、数量和频度、输入媒体、输入数据的来源 和安全保密条件等等。4.5输出项给出对每一个输出项的特性，包括名称、标识、数据的类型和格式， 数据值的有效范围，输出的形式、数量和频度，输出媒体、对输出图形及符 号的说明、安全保密条件等等。4.6算法详细说明本程序所选用的算法，具体的计算公式和计算步骤。4. 7流程逻辑用图表（例如流程图、判定表等）辅以必要的说明来表示本程序的逻辑流 程。4.8 接口用图的形式说明本程序所隶属的上一层模块及隶属于本程序的下一 层模块、子程序，说明参数赋值和调用方式，说明与本程序相直接关联的数 据结构（数据库、数据文卷）。4. 9存储分配根据需要，说明本程
8、序的存储分配。4.10注释设计说明准备在本程序中安排的注释，如：a. 加在模块首部的注释；b. 加在各分枝点处的注释；c. 对各变量的功能、范围、缺省条件等所加的注释；d. 对使用的逻辑所加的注释等等。可根据实际情况进行填写。4.11限制条件说明本程序运行中所受到的限制条件。4. 12测试计划说明对本程序进行单体测试的计划，包括测试环境、对测试的技术要 求、输入数据、预期结果、进度安排、人员职责、设备条件驱动程序及桩模 块等的规定。4.13尚未解决的问题说明在本程序的设计中尚未解决而设计者认为在软件完成之前应解决的 问题。5. 程序2 （标识符）设计说明用类似“4”的方式，说明第2个程序乃至第
9、N个程序的设计考虑。附件1服务/事务清单服务/事务 清单编号节点名称设计者审核者完成 日期编号服务名 称所属 系统相关程 序服务说明附件2程序清单程序清单编号子系统名 称节点名称审核者完成日期编号程序名称功能说 明实现程 序的文 件清单附件3代码清单代码清单编号子系统名称节点名称审核者完成日期编号源程序名 称程序说明附件4公用函数/类清单公用函数/类清单编号子系统名 称节点名称审核者完成日期编名称功能说明编名称功能说明号号附件5程序设计5.1程序设计1程序设计名称所属系 统预期实现 的平台设计者审核者完成日期输入输出处理流程XXXX 年 XX fl XX Page 12 ofXXXX-XX-X
10、XX-XX14程序设计名称所属系 统预期实现 的平台设计者审核者完成日期5. 2程序设计2输入输出处理流程附件6类设计名称所属系 统预期实现 的平台文件名设计 者审核 者完成日期类设 计定义说明属性xxxx-xx-xxx-xx14XXXX 年 XX fl XX Page 13 of成员函数依说附件7函数设计（含成员函数）函数设计名称所属系 统预期实现的平 台文件名设计 者审核 者完成日期输入输出处理流程XXXX 年 XX fl XX Page 14 of附件8存储过程设计XXXX-XX-XXX-XX14存储过程设 计名称所属系 统预期实现 的平台设计者审核者完成日 期输入输出处理流程XXXX 年 XX fl XX Page 16 of附件9数据结构清单数据结构清 单编号名称所属系统设计者审核 者完成日期编号数据结构定义说明涉及该结构的模块XXXX-XX-XXX-XX14详细设计说明书版本号：X.XXXXX年XX月XX日Page 17 ofxxxx-xx-xxx-xx17
