软件开发设计文档模板

文档变更纪录

更改人 1

日期 更改内容 创建文件 目 录

开发规划 .......................................................................................................................................................... 1.1 1.2 1.3 1.4

开发人员 ......................................................................................................................................................... 开发计划 ......................................................................................................................................................... 开发环境和工具 ............................................................................................................................................ 开发规范 ......................................................................................................................................................... 概念术语描述 ................................................................................................................................................

2 总体设计 .......................................................................................................................................................... 2.1

3 4

5

6

2.1.1 术语1 ...................................................................................................................................................... 2.1.2 术语2 ...................................................................................................................................................... 2.2 基本设计描述 ................................................................................................................................................ 2.2.1 系统总体逻辑结构图 ......................................................................................................................... 2.2.2 系统部署结构图 .................................................................................................................................. 2.3 主要界面流程描述 ....................................................................................................................................... 2.3.1 功能1界面流程 .................................................................................................................................. 2.3.2 功能2界面流程 .................................................................................................................................. 2.4 模块列表 ......................................................................................................................................................... 数据结构 .......................................................................................................................................................... 接口规范 .......................................................................................................................................................... 4.1 <模块1 API> ................................................................................................................................................. 4.1.1 Interface1 ................................................................................................................................................ 4.1.2 Interface2 ................................................................................................................................................ 4.2 <模块2 API> ................................................................................................................................................. 4.3 <模块3 API> ................................................................................................................................................. 4.4 <数据库API> ............................................................................................................................................... 模块设计 .......................................................................................................................................................... 5.1 MODULE1设计 ............................................................................................................................................... 5.1.1 模块设计描述 ...................................................................................................................................... 5.1.2 模块界面描述 ...................................................................................................................................... 5.2 MODULE2设计 ............................................................................................................................................... 附录 ................................................................................................................................................................... 6.1 第三方组件 ..................................................................................................................................................... 6.2 参考资料 .........................................................................................................................................................

6.3 附加文档 .........................................................................................................................................................

开发规划

开发人员 角 色 主要职责 项目经 项目全面负责 理  项目设计 PM  主要框架/模块编写  项目进度控制 产品经 定义需求 理  产品监督 PT  结果验证（测试）  用户文档 程序员 DEV 程序员 DEV 开发计划 负责模块 人员  xxx模块 xxx 备注 无 xxx  xxx模块 xxx  xxx模块 xxx <附开发计划表>

开发环境和工具

开发工具 工具 Delphi 7 VBA VS.NET 开发规范 作用 .net客户端 开发Excel插件 Web页面，Web Service 位置 文档名称 Delphi编码规范 系统目录规范 总体设计

概念术语描述 术语1

<术语1的描述>

术语2

<术语2的描述>

基本设计描述

<文字性的设计思路> 系统总体逻辑结构图 层/包2 层/包1 模块1 模块1 模块3 模块2 模块2 系统部署结构图 主要界面流程描述 功能1界面流程 功能2界面流程 模块列表 数据库服务器 Web服务器 防火墙 模块名称(英文) 模块1 Module1 模块2 Module2 模块3 内部客户机 Module3 功能 内部客户机 系统网络拓扑结构 备注 INTERNET 远程客户机 VPN/ 远程客户机 数据结构

数据库表列表 表名 作用 <附SQL数据库结构定义文档>

接口规范

<模块1 API>

 描述

<模块功能和设计描述(简要描述)>  集成和部署

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

Interface1

 Function1

string function1(int param1, string param2, …) param1 - param2 -  Function2

string function2(int param1, string param2, …) param1 - param2 -

Interface2 <模块2 API> <模块3 API> <数据库API>

定义数据库存储过程接口

模块设计

Module1设计

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

模块设计描述 模块界面描述 Module2设计

附录

第三方组件

Delphi组件

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

组件名称 版本 用途 参考资料 Design Pattern -

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