软件开发 软件详细设计模版.docVIP

PAGE XX项目XX模块软件 详细设计说明 文 档 编 制 编写日期 系统主设计师审核 审核日期 项目经理审核 审核日期 技术总工批准 批准日期 文档模板修改纪录表 日期 修改人 修改内容描述 2012.05.23 董雄杰 增加封面系统主设计师、项目经理审核和技术总工批准 文档修订控制 序号 版本号 修订日期 修订概述 修订人 备注 目录 TOC \o 1-2 \h \z 1. 引言 1 1.1 编写目的 1 1.2 定义 1 1.3 参考资料 1 2. 概述 1 3. 数据说明 1 4. 系统数据流图 1 5. 模块业务流程 1 6. 主模块设计说明 1 6.1 模块描述 1 6.2 模块流程图 1 6.3 模块测试和调试支持信息说明 1 6.4 其他说明（可选） 1 7. 子模块1说明 1 8. 子模块2说明 1 9. 尚未解决的问题（可选） 1 引言 编写目的 阐明编写详细设计说明书的目的。 定义 列出本文中所用到的专门术语的定义和缩写词的原意。 参考资料 列出有关的参考资料，如： 本项目经核准的计划任务书或合同，上级机关的批文； 属于本项目的其他已发表的文件； 本文件中各处引用的文件、资料，包括所用到的软件开发标准。 列出这些文件的标题、发表日期、出版单位等。 概述 简述该模块的地位、功能及模块的组成。 数据说明 例如：常量说明； 变量说明：全局变量和重要的局部变量说明； 数据类型说明：包括类型说明、对象类的层次结构说明等； 信号量和全局变量的说明； 数据库说明：结构定义、数据量等（视各模块的具体情况可选）； 其他说明：需要的大量内存说明、重要算法说明、通信协议格式说明、任务和消息队列 说明、进程和线程说明等。 系统数据流图 系统对数据的处理过程及数据流图。 模块业务流程 用流程图、文字说明模块的整体业务流程。 主模块设计说明 模块描述 功能、性能描述； 原型定义； 输入、输出和错误代码说明(输出包括参数输出、消息队列和事件等); 模块间的调用关系及接口； 注释设计说明。 模块流程图 以流程图的形式说明主模块的具体实现方法。 模块测试和调试支持信息说明 对本模块进行模块化测试的测试点及测试方法； 说明正常运行所需要的调试支持信息，对其它模块的配合要求。 其他说明（可选） 本模块的特殊说明。 子模块1说明 功能、性能描述； 原型定义； 输入、输出和错误代码说明(输出包括参数输出、消息队列和事件等); 模块间的调用关系及接口； 流程图； 注释设计说明。 子模块2说明 功能、性能描述； 原型定义； 输入、输出和错误代码说明(输出包括参数输出、消息队列和事件等); 模块间的调用关系及接口； 流程图； 注释设计说明。 尚未解决的问题（可选）