文档内容
软件开发设计文档
I文档管理信息表
主题
版本
内容
关键字
参考文档
创建时间
创建人
最新发布日期
文档变更纪录
更改人 日期 更改内容
2004-1-1 创建文件
II文档主要评审意见
产品组
评审人员 日期 意见
QA组
评审人员 日期 意见
III目 录
1 开发规划...........................................................................................................................................1
1.1 开发人员...................................................................................................................................1
1.2 开发计划...................................................................................................................................2
1.3 开发环境和工具.......................................................................................................................3
1.4 开发规范...................................................................................................................................3
2 总体设计...........................................................................................................................................4
2.1 概念术语描述...........................................................................................................................4
2.1.1 术语1...............................................................................................................................4
2.1.2 术语2...............................................................................................................................4
2.2 基本设计描述...........................................................................................................................5
2.2.1 系统总体逻辑结构图......................................................................................................5
2.2.2 系统部署结构图..............................................................................................................6
2.3 主要界面流程描述...................................................................................................................7
2.3.1 功能1界面流程...............................................................................................................7
2.3.2 功能2界面流程...............................................................................................................7
2.4 模块列表...................................................................................................................................8
3 数据结构...........................................................................................................................................9
4 接口规范.........................................................................................................................................10
4.1 <模块1 API>..........................................................................................................................10
4.1.1 Interface1........................................................................................................................10
4.1.2 Interface2........................................................................................................................10
4.2 <模块2 API>..........................................................................................................................11
4.3 <模块3 API>..........................................................................................................................11
4.4 <数据库API>.........................................................................................................................11
5 模块设计.........................................................................................................................................12
5.1 MODULE1设计.......................................................................................................................12
5.1.1 模块设计描述................................................................................................................12
5.1.2 模块界面描述................................................................................................................12
5.2 MODULE2设计.......................................................................................................................13
6 附录.................................................................................................................................................14
6.1 第三方组件.............................................................................................................................14
6.2 参考资料.................................................................................................................................15
6.3 附加文档.................................................................................................................................15
IVVxx项目.项目目标
1 开发规划
1.1 开发人员
角 色 主要职责 负责模块 人员 备注
项目经理 项目全面负责 xxx模块 xxx
PM 项目设计
主要框架/模块编写
项目进度控制
产品经理 定义需求 无 xxx
PT 产品监督
结果验证(测试)
用户文档
程序员 xxx模块 xxx
DEV
程序员 xxx模块 xxx
DEV
1xx项目.项目目标
1.2 开发计划
<附开发计划表>
2xx项目.项目目标
1.3 开发环境和工具
开发工具
工具 作用
Delphi 7 .net客户端
VBA 开发Excel插件
VS.NET Web页面,Web Service
1.4 开发规范
文档名称 位置
Delphi编码规范
系统目录规范
3xx项目.项目目标
2 总体设计
2.1 概念术语描述
2.1.1 术语1
<术语1的描述>
2.1.2 术语2
<术语2的描述>
4xx项目.项目目标
2.2 基本设计描述
<文字性的设计思路>
2.2.1 系统总体逻辑结构图
层/包1
模块1
模块2 模块3
层/包2
模块1
模块2
5xx项目.项目目标
2.2.2 系统部署结构图
数据库服务器 Web服务器 防火墙
VPN/
INTERNET
内部客户机 内部客户机 远程客户机 远程客户机
系统网络拓扑结构
6xx项目.项目目标
2.3 主要界面流程描述
2.3.1 功能1界面流程
2.3.2 功能2界面流程
7xx项目.项目目标
2.4 模块列表
模块名称(英文) 功能 备注
模块1
Module1
模块2
Module2
模块3
Module3
8xx项目.项目目标
3 数据结构
数据库表列表
表名 作用
<附SQL数据库结构定义文档>
9xx项目.项目目标
4 接口规范
4.1 <模块1 API>
描述
<模块功能和设计描述(简要描述)>
集成和部署
<描述模块如何同系统集成,实现形式是DLL, EXE或是嵌入式代码>
4.1.1 Interface1
Function1
string function1(int param1, string param2, …)
param1 -
param2 -
Function2
string function2(int param1, string param2, …)
param1 -
param2 -
4.1.2 Interface2
10xx项目.项目目标
4.2 <模块2 API>
4.3 <模块3 API>
4.4 <数据库API>
定义数据库存储过程接口
11xx项目.项目目标
5 模块设计
5.1 Module1设计
<更具具体情况细化模块设计>
5.1.1 模块设计描述
5.1.2 模块界面描述
12xx项目.项目目标
5.2 Module2设计
13xx项目.项目目标
6 附录
6.1 第三方组件
Delphi组件
组件名称 版本 用途
.NET组件
组件名称 版本 用途
14xx项目.项目目标
6.2 参考资料
Design Pattern -
6.3 附加文档
文档名称 文件名 描述
项目计划表 Wind.net.plan.mpp 项目时间规划
数据库定义 X****.sql 数据库定义脚本
***
15