实训项目文档模板

《××××××》项目文档
学号：
姓名：
目录
1.需求分析 (3)
1.1需求描述 (3)
1.2用例图 (3)
2.概要设计 (3)
2.1模块图 (3)
2.2模块描述 (3)
2.3时序图 (3)
2.4界面图 (3)
2.5数据库 (3)
3.模块详细设计 (3)
3.1文件一览 (3)
3.2函数一览 (4)
3.3函数调用关系.................................................................................................. 错误！未定义书签。

3.4宏定义 (5)
3.5消息一览 (5)
3.6数据类型定义 (5)
3.7全局变量定义 (5)
3.8数据表设计...................................................................................................... 错误！未定义书签。

3.9接口函数设计 (6)
3.9.1函数1（实际函数名） (6)
3.9.2函数2 (7)
3.10内部函数设计 (7)
3.10.1函数1（实际函数名） (7)
3.10.2函数2 (8)
3.10.3函数3 (8)
3.11流程图 .......................................................................................................... 错误！未定义书签。

3.11.1函数1（实际函数名） ....................................................................... 错误！未定义书签。

3.11.2函数2 ................................................................................................... 错误！未定义书签。

1.需求分析
1.1需求描述
1.2用例图
2.概要设计
2.1模块图
框架结构
2.2模块描述
功能点描述
2.3时序图
见：参考文档（超链接）2.4界面图
2.5数据库
表…
3.模块详细设计
3.1文件一览
例：
3.2函数一览
例：
3.3宏定义
例：
ucPowerStatus (Power状态变量)使用的宏定义一览
3.4消息一览
例：
3.5数据类型定义
说明：
自定义的数据类型、主要指结构体。

3.6全局变量定义
说明：
模块中使用到的全局变量。

3.7接口函数设计
说明：
详细描述本模块提供的接口的函数。

此章节为他模块提供IF使用指导信息。

3.7.1函数1（实际函数名）
说明：
关于函数流程、可以画流程图、也可以画P AD图、细化到2～4行代码、逻辑简单的函数可以不画流程图、但要把实现的功能详细描述清楚。

要使用部门统一的标准模具和模版来描画流程图。

3.7.2函数2
例：
3.8内部函数设计
说明：
模块内部函数
3.8.1函数1（实际函数名）
例：
3.8.2函数2
例：
3.8.3函数3
例：。