ZD-模塊设计说明书-ProductID-Vx.x.docVIP

项目名称 模块设计说明书 Version 1.0 文档名称：ZD-模块设计说明书-ProductID-Vx.x.doc 修订历史记录 日期 版本号 修改说明 修改人 核准人 2012/4/11 1.0 首次撰写 韩苓 目录 1 引言 4 1.1 目的与范围 4 1.2 预期的读者 4 1.3 参考资料 4 1.4 定义、缩写词 4 2 模块命名规则 4 3 模块汇总 4 3.1 模块汇总表 4 3.2 模块关系图 4 4 模块设计清单 5 4.1 子系统A的模块设计 5 4.1.1 模块A_1 5 4.2 子系统B的模块设计 5 4.2.1 模块B_1 5 5 附录 5 模块设计说明书 引言 目的与范围 [本文档的作用与目标的描述，内容覆盖的范围。] 预期的读者 [列举本文档所针对的不同读者，例如开发人员、测试人员，项目经理等。描述文档的组织结构，提出最适合每一类读者阅读的阅读建议。可以用超链接技术把各角色所关心的内容列出来，进行方便地跳转。] 参考资料 [对本文档中涉及到的参考资料进行列表描述，例如应该参考概要设计阶段的各文档。] 定义、缩写词 [说明本文档中所使用到的定义、缩写词等。] 模块命名规则 [模块设计人员确定本软件中的模块命名规则，如类、变量、函数、参数等的命名规则。这样主要是为了使模块设计与编码风格保持一致。命名规则可以参考公司的编码规范以及项目组内部的编码规范，如果是增强型项目，还要与以前的风格保持一致。] 模块汇总 模块汇总表 [列出系统中所有的模块。可以参考概要设计文档中的子系统划分等部分。] 子系统A 模块名称 功能简述 … 子系统B 模块名称 功能简述 … 模块关系图 [用图形的方式直观地表示出各模块之间的关系，可以参考概要设计中的组件图，并进行适当的细化。] 模块设计清单 子系统A的模块设计 [第一个子系统的模块设计，其他子系统按照相同的格式另起一个标题进行设计。] [对本子系统中的模块逐个进行设计。每个子模块就是一个小节。下面是第一个模块的模板，其他模块按照相同的方式进行处理。] 模块A_1 模块名称 功能描述 接口与属性 说明：可以利用专业的设计、开发工具设计接口说明，比如函数名称、参数、返回值、调用规格说明等。在本处把设计号的结果粘贴过来就可以了。也可以采用一定的规格进行描述。 数据结构与算法 说明：不论是经典的还是专用的数据结构与算法，都应该做必要地描述。不仅用于指导程序地实现，还可以让人们清楚地了解对象类或模块是如何实现地。 补充说明 子系统B的模块设计 [第二个子系统的模块设计，其他子系统按照相同的格式另起一个标题进行设计。] [对本子系统中的模块逐个进行设计。每个子模块就是一个小节。下面是第一个模块的模板，其他模块按照相同的方式进行处理。] 模块B_1 模块名称 功能描述 接口与属性 说明：可以利用专业的设计、开发工具设计接口说明，比如函数名称、参数、返回值、调用规格说明等。在本处把设计号的结果粘贴过来就可以了。也可以采用一定的规格进行描述。 数据结构与算法 说明：不论是经典的还是专用的数据结构与算法，都应该做必要地描述。不仅用于指导程序地实现，还可以让人们清楚地了解对象类或模块是如何实现地。 补充说明 附录 [说明其他需要阐明的问题，或者其他设计相关的附件。比如如果对数据库的详细设计利用CASE工具进行，就可以把设计的结果文件作为附件，放到这里。] 模块设计说明书 项目名称 Version 1.0 武汉中地数码科技有限公司 模板版本：1.0 Page 2 of 5 武汉中地数码科技有限公司 模板版本：1.0 Page 1 of 5