项目名称详细设计说明书文档版本号.doc
文件编号文件编号NEWSEASE-PM-D10 配置项编号配置项编号[ [部门部门] ]- -[ [系统名系统名]-]-[ [版本号版本号]-D-DDS-]-D-DDS-[ [版本号版本号] ] 项目名称项目名称 (项目英文名称)(项目英文名称) 详细设计说明书详细设计说明书 文档版本号文档版本号 编编 写写 人人 编写时间编写时间 部部 门门 名名 审审 核核 人人 审核时间审核时间 浙江兰德新易信息技术有限公司 1 修订页修订页 编号 章节 名称 修订内容简述 修订 日期 修订前 版本号 修订后 版本号 修订人批准人 浙江兰德新易信息技术有限公司 1 目录目录 1.1. 引言引言 ................................................................................................................................................................1 1.1 编写目的 ...................................................................................................................................................1 1.2 项目背景 ...................................................................................................................................................1 1.3 定义 ...........................................................................................................................................................1 1.4 参考资料 ...................................................................................................................................................1 2.2. 软件结构软件结构 ........................................................................................................................................................1 3.3. 模块描述模块描述 ........................................................................................................................................................1 3.1 功能 ...........................................................................................................................................................2 3.2 性能 ...........................................................................................................................................................2 3.3 输入项目 ...................................................................................................................................................2 3.4 输出项目 ...................................................................................................................................................2 3.5 数据结构 ...................................................................................................................................................2 3.5.1全局数据结构.....................................................................................................................................2 3.5.2局部数据结构.....................................................................................................................................2 3.6 算法 ...........................................................................................................................................................2 3.7 接口 ...........................................................................................................................................................3 3.8 存储分配 ...................................................................................................................................................3 3.9 限制条件 ...................................................................................................................................................3 3.10 测试要点 .................................................................................................................................................3 3.11 程序文件清单 .........................................................................................................................................3 3.11.1子系统名...........................................................................................................................................3 3.11.2程序文件名.......................................................................................................................................3 3.11.3运行平台...........................................................................................................................................3 3.11.4编程语言...........................................................................................................................................3 3.11.5简要描述...........................................................................................................................................3 浙江兰德新易信息技术有限公司 1 1.1. 引言引言 1.11.1 编写目的编写目的 阐明编写详细设计说明书的目的,并指出读者对象。 1.21.2 项目背景项目背景 包括项目的来源和主管部门等。 1.31.3 定义定义 列出文档中所用到的专门术语的定义和缩写词的原意。 1.41.4 参考资料参考资料 列出有关资料的作者、标题、编号、发表日期和出版单位或资料来源,可包括 a项目的计划任务书、合同、批文 b项目开发计划 c需求规格说明书 d概要设计说明书 e测试计划书初稿 f用户操作手册初稿 g文档中所引用的其他资料、软件开发标准或规范 2.2. 软件结构软件结构 它在两个层次上描述软件结构。首先,它包括概要设计阶段给出的程序结构,即把概要设计说明 书软件结构图移植过来。其次,对应于详细设计阶段的模块功能分解任务,而得到模块子结构图,即 模块的内部结构,这是功能分解的结果。这个抽象层次是必要的。理由有二(1)在概要设计阶段, 考虑的功能的”粒度”要粗些,总是忽略某些细节,而在详细设计阶段则必须给出全部细节,这时必 会对某些复杂的功能进一步分解; (2)在设计算法时,会有一些用语方面的考虑。如模块规模要 适中,模块的单入口单出口等,这样可能对大模块或入口条件太多的模作进一步细化。 3.3. 模块描述模块描述 逐步给出各个层次中每个模块的过程设计考虑,既包括概要设计阶段中得到的模块,又要包括详 细设计阶段得到的子模块。对于具体的模块,特别是较低层次的模块或子程序,其很多条目的内容往 浙江兰德新易信息技术有限公司 2 往与它所隶属的上一层模块的对应条目的内容相同,在这种情况下,只要简单地说明这一点即可。 3.13.1 功能功能 详细描述此模块(子程序)要完成的主要功能。 3.23.2 性能性能 说明该程序应具有的性能,可采用 IPO 图(即输入-处理-输出图)的形式。 3.33.3 输入项目输入项目 给出每一个输入项的特性,包括名称、标识、数据的类型和格式,数值的有效范围;输入的方式、 数量和频度、输入媒体、输入数据的来源和安全保密条件等等。 3.43.4 输出项目输出项目 给出每一个输出项的特性,包括名称、标识、数据的类型和格式、数值的有效范围、输出的方式、数 量和频度、输出媒体、对输出图形及符号的说明、安全保密条件等等。 3.53.5 数据结构数据结构 数据结构,给出全局的和局部的数据结构或数据元素(变量)的特性。包括名称、标识符、数 据类型和格式,值的有效范围,是仅仅使用,还是有修改/产生动作等,并给出定义性描述。 3.5.13.5.1 全局数据结构全局数据结构 名称标识符类型使用方式访问方式描述 3.5.23.5.2 局部数据结构局部数据结构 名称标识符类型使用方式访问方式描述 3.63.6 算法算法 详细说明本程序所选用的算法、具体的计算公式和计算步骤。算法用结构化图式语言表示,详细 描述模块实现的算法可采用 a标准流程图 浙江兰德新易信息技术有限公司 3 bPDL 语言 cN-S 图 dPAD e判定表等描述算法的图表 3.73.7 接口接口 用图的形式说明本所属的下一层模块,子程序。说明参数赋值和调用方式,说明与本程序直接相关联 的数据结构(数据库、数据文卷) 。 3.83.8 存储分配存储分配 根据需要,说明本程序的存储分配。 3.93.9 限制条件限制条件 说明该程序运行过程中所受到的限制条件。 3.103.10 测试要点测试要点 说明对本程序进行单体测试的计划,包括对测试的技术要求、输入数据、预期结果、进度安排、 人员职责、设备条件驱动程序及模块等的规定。 3.113.11 程序文件清单程序文件清单 3.11.13.11.1 子系统名子系统名 3.11.23.11.2 程序文件名程序文件名 3.11.33.11.3 运行平台运行平台 3.11.43.11.4 编程语言编程语言 3.11.53.11.5 简要描述简要描述