软件模块设计报告模板

XXXX软件项目

模块设计

XXXX企业有限公司

____年___月___日

文档信息

修改记录

目录

软件项目模块设计 (3)

1 引言 (3)

1.1 编写目的 (3)

1.2 范围 (3)

1.3 术语定义 (3)

1.4 参考资料 (3)

2 模块命名规则 (3)

3 模块汇总 (4)

3.1 模块汇总表 (4)

3.2 模块关系图 (4)

3.3 包及类命名汇总表 (4)

4 模块设计 (5)

4.1 模块一 (5)

4.1.1 设计说明（可选） (5)

4.1.2 界面功能设计 (5)

4.1.3 协作图 (5)

4.1.4 单元测试用例 (5)

4.1.5 算法说明（可选） (5)

4.1.6 类设计（可选） (6)

4.1.7 数据库表（可选） (6)

5 其它（可选） (6)

6 附录 (6)

软件项目模块设计

1 引言

1.1 编写目的

1.2 范围

简要描述项目的范围。

1.3 术语定义

列出本文件中用到的专门术语的定义和外文首字母组词的原词组。

1.4 参考资料

列出用得着的参考资料，如：

1、本项目的经核准的计划任务书或合同、上级机关的批文等；

2、属于本项目的其他已发表的文件；

3、本文件中引用的文件、资料、包括所要用到的软件开发标准。

列出这些文件资料的标题、文件编号、发表日期和出版单位，说明能够得到这些文件资料的来源。

2 模块命名规则

模块设计人员确定本软件的模块命名规则（例如类、函数、变量等），确保模块设计文档的风格与代码的风格保持一致。可以从机构的编程规范中摘取或引用（如果存在的话）。

3 模块汇总

3.1 模块汇总表

参考架构设计总体功能架构。

3.2 模块关系图

参考体系结构设计文档

3.3 包及类命名汇总表

包命名规范，以com.xxxx.projects开头+项目名+细分的包名。参见Java 编码规范及实践

一级包名填项目名+大的包名，以demo做项目名为例，业务包命名为com.xxxx.projects.demo.business，工具包命名为com.xxxx.projectsl.demo.utils。二级及以下级包名根据设计人员自己设计要求

命名，并描述其功能用途。

接口和类命名(对应二级及以下级包内的)，及其功能描述。表的内容比较挤，也可以分开成两张表独立描述，表头为：包名、接口或类命名、接口或类功能简要描述。

命名规则均要求遵循ava编码规范及实践

4 模块设计

4.1 模块一

4.1.1 设计说明（可选）

对模块的设计进行文字说明。

4.1.2 界面功能设计

较复杂界面类用Word或Visio等工具简单画出界面。强调界面上具备的操作功能

4.1.3 协作图

较复杂功能画出协作图，简单的CRUD功能可以省略，复杂功能可以放多个协作图。若设计人员采用序列图表示交互行为，将该节改为序列图

4.1.4 单元测试用例

列出模块的单元测试要点

4.1.5 算法说明（可选）

对较复杂的成员方法的逻辑进行说明。

4.1.6 类设计（可选）

对涉及的类的属性和方法进行详细说明，考虑设计模式。

4.1.7 数据库表（可选）

列出需要访问的数据库表。

5 其它（可选）

6 附录