软件设计文档模板.doc

河南省检察机关档案信息化管理系统项目.项目目标

软件设计文档

目 录

1 开发规划 3
1.1 开发人员 3
1.2 开发计划 4
1.3 开发环境和工具 5
1.4 开发规范 5
2 总体设计 6
2.1 概念术语描述 6
2.1.1 术语1 6
2.1.2 术语2 6
2.2 基本设计描述 7
2.2.1 系统总体逻辑结构图 7
2.2.2 系统部署结构图 8
2.3 主要界面流程描述 9
2.3.1 功能1界面流程 9
2.3.2 功能2界面流程 9
2.4 模块列表 10
3 数据结构 11
4 接口规范 12
4.1 <模块1 API> 12
4.1.1 Interface1 12
4.1.2 Interface2 12
4.2 <模块2 API> 13
4.3 <模块3 API> 13
4.4 <数据库API> 13
5 模块设计 14
5.1 Module1设计 14
5.1.1 模块设计描述 14
5.1.2 模块界面描述 14
5.2 Module2设计 15
6 附录 16
6.1 第三方组件 16
6.2 参考资料 17
6.3 附加文档 17

1 开发规划

1.1 开发人员

角 色
主要职责
负责模块
人员
备注
项目经理
PM

n 项目全面负责
n 项目设计
n 主要框架/模块编写
n 项目进度控制
n xxx模块
xxx

产品经理
PT
n 定义需求
n 产品监督
n 结果验证（测试）
n 用户文档
无
xxx

程序员
DEV
n
n xxx模块
xxx

程序员
DEV
n
n xxx模块
xxx

n
n

1.2 开发计划

<附开发计划表>

1.3 开发环境和工具

开发工具
工具
作用
Delphi 7
.net客户端
VBA
开发Excel插件
VS.NET
Web页面，Web Service

1.4 开发规范
文档名称
位置
Delphi编码规范

系统目录规范

2 总体设计
2.1 概念术语描述

2.1.1 术语1
<术语1的描述>

2.1.2 术语2
<术语2的描述>

2.2 基本设计描述

<文字性的设计思路>

2.2.1 系统总体逻辑结构图

层/包1

模块1

模块3
模块2

层/包2
模块2
模块1

2.2.2 系统部署结构图

数据库服务器
Web服务器
防火墙
内部客户机
内部客户机
VPN/
INTERNET
远程客户机
远程客户机
系统网络拓扑结构

2.3 主要界面流程描述

2.3.1 功能1界面流程

2.3.2 功能2界面流程

2.4 模块列表

模块名称(英文)
功能
备注
模块1
Module1

模块2
Module2

模块3
Module3

3 数据结构

数据库表列表
表名
作用

<附SQL数据库结构定义文档>

4 接口规范

4.1 <模块1 API>

l 描述
<模块功能和设计描述(简要描述)>

l 集成和部署
<描述模块如何同系统集成，实现形式是DLL, EXE或是嵌入式代码>

4.1.1 Interface1
<interface1 description>

l Function1
string function1(int param1, string param2, …)
<function1 description>
param1 - <param1 description>
param2 - <param2 description>

l Function2
string function2(int param1, string param2, …)
<function2 description>
param1 - <param1 description>
param2 - <param2 description>

4.1.2 Interface2

4.2 <模块2 API>

4.3 <模块3 API>

4.4 <数据库API>

定义数据库存储过程接口

5 模块设计

5.1 Module1设计

<更具具体情况细化模块设计>

5.1.1 模块设计描述

5.1.2 模块界面描述

5.2 Module2设计

6 附录
6.1 第三方组件

Delphi组件
组件名称
版本
用途

.NET组件
组件名称
版本
用途

6.2 参考资料

Design Pattern -

6.3 附加文档

文档名称
文件名
描述
项目计划表
W.plan.mpp
项目时间规划
数据库定义
X****.sql
数据库定义脚本
***

17