软件开发设计文档模板

软件开发设计文档

文档管理信息表

文档变更纪录

文档主要评审意见

QA

组

目 录

1

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

开发人员 ................................................................................................................................. 1 开发计划 ................................................................................................................................. 2 开发环境和工具 ..................................................................................................................... 3 开发规范 ................................................................................................................................. 3

总体设计 .......................................................................................................................................... 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 4

数据结构 .......................................................................................................................................... 9 接口规范 ........................................................................................................................................ 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 6.2 6.3

第三方组件 ........................................................................................................................... 14 参考资料 ............................................................................................................................... 15 附加文档 ............................................................................................................................... 15

V

开发规划

开发人员

开发计划

<附开发计划表>

开发环境和工具

开发工具

总体设计

概念术语描述

术语1

<术语1的描述>

术语2

<术语2的描述>

基本设计描述

<文字性的设计思路>

系统总体逻辑结构图

系统部署结构图

内部客户机

内部客户机

系统网络拓扑结构

远程客户机 远程客户机

主要界面流程描述

功能1界面/流程

功能2界面/流程

模块列表

数据结构

数据库表列表

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

接口规范

<模块1 API>

描述

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

集成和部署

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

Interface1

<interface1 description>

Function1

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

param1 - <param1 description> param2 - <param2 description>

Function2

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

param1 - <param1 description> param2 - <param2 description>

Interface2

<模块2 API>

<模块3 API>

<数据库API>

定义数据库存储过程接口

模块设计

Module1设计

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

模块设计描述

模块界面描述

Module2设计

附录

第三方组件

参考资料

Design Pattern -

附加文档

本文来源：https://www.bwwdw.com/article/q3d1.html