软件开发设计文档
本文整理软件开发基本设计文档需要包含的要素。
目录
开发规划
开发人员
角 色 | 主要职责 | 负责模块 | 人员 | 备注 |
|---|---|---|---|---|
项目经理 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 |
开发计划
<附开发计划表>
开发环境和工具
开发工具
工具 | 作用 |
|---|---|
Delphi 7 | .net客户端 |
VBA | 开发Excel插件 |
VS.NET | Web页面，Web Service |
开发规范
文档名称 | 位置 |
|---|---|
Delphi编码规范 | |
系统目录规范 | |
总体设计
概念术语描述
术语1
<术语1的描述>
术语2
<术语2的描述>
基本设计描述
<文字性的设计思路>
系统总体逻辑结构图
系统部署结构图
主要界面流程描述
功能1界面流程
功能2界面流程
模块列表
模块名称(英文) | 功能 | 备注 |
|---|---|---|
模块1 Module1 | ||
模块2 Module2 | ||
模块3 Module3 |
数据结构
数据库表列表
表名 | 作用 |
|---|---|
<附SQL数据库结构定义文档>
接口设计
<模块1 API>
l 描述
<模块功能和设计描述(简要描述)>
l 集成和部署
<描述模块如何同系统集成，实现形式是DLL, EXE或是嵌入式代码>
Interface1
l Function1
string function1(int param1, string param2, …)
param1 -
param2 -
l Function2
string function2(int param1, string param2, …)
param1 -
param2 -
Interface2
<模块2 API>
<模块3 API>
<数据库API>
定义数据库存储过程接口
模块设计
Module1设计
<更具具体情况细化模块设计>
模块设计描述
模块界面描述
Module2设计
运行设计
系统初始化
说明本系统初始化过程。
运行模块组合
说明本系统每项外界运行需经过哪些内部模块的组合和支持软件。
运行控制
说明每项外界运行的控制方式、方法和操作步骤。
运行时间
说明每项运行模块组合预计占用各种资源的时间。
运行安全
说明系统安全运行的控制。
错误处理
出错信息
用一览表列出本系统各种可能出错或故障的信息形式及其含义。
补救措施
说明系统故障出现后可能采取的变通措施，包括：
- 后备技术——当系统原始数据一旦丢失时，启用副本的建立和启动技术；
- 降效技术——使用另一效率稍低的方法以求得所需结果的某些部份，如手工操作和人工记录数据；
- 恢复及再启动技术——让系统从故障点恢复执行或系统从新启动运行的方法等。
系统维护
说明专门安排用于系统检测与维护的检测点和系统检测维护的专用模块等。
安全设计
尚待解决的问题
说明本设计中尚未解决而系统完成之前应该解决的问题。
附录
第三方组件
Delphi组件
组件名称 | 版本 | 用途 |
|---|---|---|
.NET组件
组件名称 | 版本 | 用途 |
|---|---|---|
参考资料
附加文档
文档名称 | 文件名 | 描述 |
|---|---|---|
项目计划表 | Wind.net.plan.mpp | 项目时间规划 |
数据库定义 | X.sql | 数据库定义脚本 |
* | ||
文档管理信息表
主题 | |
|---|---|
版本 | |
内容 | |
关键字 | |
参考文档 | |
创建时间 | |
创建人 | |
最新发布日期 |
文档变更纪录
更改人 | 日期 | 更改内容 |
|---|---|---|
创建文件 | ||
产品组
评审人员 | 日期 | 意见 |
|---|---|---|
QA组
评审人员 | 日期 | 意见 |
|---|---|---|