项目名称,《模块设计报告》
{ 项目名称 }
模块设计报告
文件状态: [√] 草稿 [ ] 正式发布 [ ] 正在修改 | 文件标识: | Company-Project-SD-MODULE |
---|---|---|
当前版本: | X.Y | |
作 者: | ||
完成日期: | Year-Month-Day |
版 本 历 史
版本/状态 | 作者 | 参与者 | 起止日期 | 备注 |
---|---|---|---|---|
目 录
0. 文档介绍
0.1 文档目的
0.2 文档范围
0.3 读者对象
0.4 参考文献
***提示:*列出本文档的所有参考文献(可以是非正式出版物),格式如下:
[标识符] 作者,文献名称,出版单位(或归属单位),日期
例如:
[AAA] 作者,《立项建议书》,机构名称,日期
[SPP-PROC-SD] SEPG,系统设计规范,机构名称,日期
0.5 术语与缩写解释
缩写、术语 | 解 释 |
---|---|
SPP | 精简并行过程,Simplified Parallel Process |
SD | 系统设计,System Design |
… |
1. 模块命名规则
***提示:*模块设计人员确定本软件的模块命名规则(例如类、函数、变量等),确保模块设计文档的风格与代码的风格保持一致。可以从机构的编程规范中摘取或引用(如果存在的话)。
2. 模块汇总
2.1 模块汇总表
***提示:*这里模块是指相对独立的软件设计单元,例如对象类、函数包等等。
子系统A |
---|
模块名称 |
… |
子系统B |
模块名称 |
… |
2.2 模块关系图
***提示:*参考体系结构设计文档
3. 子系统A的模块设计
3.n 模块A-n
模块名称 | |
---|---|
功能描述 | |
接口与属性 | **提示:**用专业的设计(开发)工具来设计本模块的接口与属性,说明函数功能、输入参数、输出参数、返回值等。此处粘贴即可。 |
数据结构 与算法 | **提示:**不论是采用经典的还是专用的数据结构与算法,都应该作必要的描述。不仅用于指导程序的实现,还可以让人们清楚地了解该对象类是如何设计的。 |
补充说明 |
4. 子系统B的模块设计
4.n 模块B-n
模块名称 | |
---|---|
功能描述 | |
接口与属性 | **提示:**用专业的设计(开发)工具来设计本模块的接口与属性,说明函数功能、输入参数、输出参数、返回值等。此处粘贴即可。 |
数据结构 与算法 | **提示:**不论是采用经典的还是专用的数据结构与算法,都应该作必要的描述。不仅用于指导程序的实现,还可以让人们清楚地了解该对象类是如何设计的。 |
补充说明 |
5. 其他
Ó 机构名称,2002 | Page 6 of 6 |
---|
作必要的描述。不仅用于指导程序的实现,还可以让人们清楚地了解该对象类是如何设计的。*
||补充说明||
5. 其他
Ó 机构名称,2002 | Page 6 of 6 |
---|