软件开发设计文档模板

软件开发设计文档

I

文档管理信息表

主题 机票预定系统 版本 1.1 内容 置于个旅行社定票点的前台客户程序，以及置于 航空公司的数据库服务器。 关键字 机票预定 参考文档 创建时间 2016.1.5 创建人 金城鹏 最新发布日期 2016.1.5

文档变更纪录

更改人 日期 更改内容 创建文件

II

文档主要评审意见

产品组 评审人员

QA组 评审人员

日期 意见 日期 意见

III

目 录

1

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

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

总体设计 .......................................................................................................................................... 4 2.1

概念术语描述 ......................................................................................................................... 4

2.1.1 术语1 ................................................................................................错误!未定义书签。 2.1.2 术语2 ................................................................................................错误!未定义书签。 2.2 基本设计描述 ......................................................................................................................... 5 2.2.1 系统总体逻辑结构图 ..................................................................................................... 5 2.2.2 系统部署结构图 ............................................................................................................. 8 2.3 主要界面流程描述 ................................................................................................................. 9 2.3.1 功能1界面流程 ............................................................................................................... 9 2.3.2 功能2界面流程 ............................................................................................................... 9 2.4 模块列表 ............................................................................................................................... 10

3 4

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

第三方组件 ........................................................................................................................... 16 参考资料 ............................................................................................................................... 17 附加文档 ............................................................................................................................... 17

IV

V xx项目.项目目标

开发规划

开发人员

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

后台开发  页面开发  金城鹏 金城鹏  

1 xx项目.项目目标

开发计划

航空公司为方便旅客，需开发一个机票预定系统。为便于旅客由旅行社代替

航空公司负责为旅客定票，旅行社把预定机票的旅客信息，包括姓名、性别、工作单 位、身份证号码、旅行时间、旅行目的地，输入机票预定系统的客户端程序，系统经 过查询航空公司内的航班数据服务器后，为旅客安排航班，印出取票通知。旅客在飞 机起飞前一天凭取票通知和帐单交款后取票，系统校对无误后即印出机票给旅客。 要求系统能有效、快速、安全、可靠和无误的完成上述操作。并要求客户机的界 面要简单明了，易于操作，服务器程序利于维护。

2 xx项目.项目目标

开发环境和工具

开发工具 工具 Delphi 7 VBA VS.NET

作用 .net客户端 开发Excel插件 Web页面，Web Service 开发规范 文档名称 Delphi编码规范 系统目录规范

位置

3 xx项目.项目目标

总体设计

概念术语描述

1 客户机程序流程

客户机上的输入信息为旅客资料或帐单号，还包括一个定票/领票选项。输出 为打印帐单或机票，和确认或出错信息。其内部处理流程如下： 旅客资料 2 3 4 服务器程序订票/取票 经网络送到 1 7 8 账单号 5 6 13 打印账单 络送来回答服务器经网9 10 12 14 11 输出预订信息 15 16 17 输出错误信息息 输出正确预订信息 18 19 14 20 打印机票息

4 xx项目.项目目标

下面对各模块（以数字表示）进行功能说明：

1 ． 读入并确定（定票 / 领票） 它是一个事务处理中心，若输入是定票时转入 2 ，输

出则转入 5。

2 ． 读入旅客资料 读取所输入的旅客资料，并将其格式化，将格式化数据送 3。 3 ． 检验输入资料 检验格式化输入资料，初步检查输入是否有误，它是一个事务处理 中心，有误则转 2 再次读入，检查无误则将数据送 4。 4 ． 准备服务器数据 由格式化旅客资料准备需发送到服务器的数据，将准备好的数据 送 7。

5 ． 读入帐单号 读取所输入的帐单号，并将其格式化，将格式化数据送 6。

6 ． 准备服务器数据 由格式化帐单号准备需发送到服务器的数据，不同于 4，它将准 备的是帐单号，将准备好的数据送 7。

7 ． 准备网络数据包 将数据准备/加密成网络传输数据包。

8 ． 网络数据发送 将数据包经网络发送到服务器程序， 它是程序与网络的接口。 9 ． 网络数据接受 接受由服务器程序经网络传送到客户机的数据包， 它是程序与网 络的接口。

10 ． 解开 / 判断 解开 9 所接受的数据包，并判断数据是定票数据或是领票数据， 它是一事务处理中心，是定票则将数据送 11，是领票则将数据送 18。

11 ． 定票成功？ 由数据判断定票是否成功，它是一事务处理中心，若定票成功则 将数据送 11，不成功则将数据送 18。

12 ． 准备输出数据 由接收的服务器数据准备输出数据，其中关于帐单的数据将送 入 13，其他包括旅客资料等送入 14。

13 ． 打印帐单 由帐单信息处理帐单格式并打印出帐单。 14 ． 输出定位确定 在屏幕上显示确定定位及其他信息。 15 ． 判断错误 由数据判断出错误类型，将类型送到 16。 16 ． 准备错误语句 由具体错误类型准备错误语句，送 17。 17 ． 输出错误语句 在屏幕上显示错误语句。

18 ． 领票核对成功？ 由数据判断领票核对是否成功，它是一事务处理中心，若成 功则将数据送 19，不成功则将数据送 15。

19 ． 准备机票输出数据 由接收的服务器数据准备将打印的机票数据数，据其中关 于帐单的机票的数据将送入 20，其他包括旅客资料等送入 14。 20 ． 打印机票 由机票信息处理机票格式并打印出机票。

基本设计描述

<文字性的设计思路>

系统总体逻辑结构图

5 xx项目.项目目标

客户程序 机场飞机起飞管理 （旅行社） 客户程序 客户程序 网络服务器及程序 客户程序

6 xx项目.项目目标

7 xx项目.项目目标

系统部署结构图

数据库服务器 内部客户机

Web服务器 防火墙 VPN/ INTERNET 内部客户机

系统网络拓扑结构

远程客户机 远程客户机

8 xx项目.项目目标

主要界面流程描述

功能1界面流程

预订机票浏览页面并提交

功能2界面流程

付款页面

9 xx项目.项目目标

模块列表

模块名称(英文) 模块1 Module1 模块2 Module2 模块3 Module3

功能 备注

10 xx项目.项目目标

数据结构

数据库表列表

1 ． 航班班次表

航班号 起飞日期/时 飞行目的地 座位空数 商务仓票价 经济仓票价 间 航班班次表保存了所有从本地起飞的班机信息，它的主键为 航班号 。在定位前先 查寻 座位空数 ，在定位后将修改 座位空数

2 ． 定位信息表

航班号 帐单号 是否领票

定位信息表保存了已定位信息，主键为 帐单号 ，外部主键为 航班号 。在旅客领票 过程时将用到此表，领票后修改 是否领票

3 ． 帐单信息/ 旅客资料表

账单号 旅客名字 旅客性别 旅客身份证号 工作单位 帐单信息/旅客资料表保存已定位的旅客信息资料，它的主键为 旅客身份证号 ，外 部主键为 帐单号 。主要用于领票时将旅客信息一同返回。

4 ． 机位信息表

班机号 机位信息 机位信息表保存各班机各机位定票状况。它的外部主键为 班机号 。主要用于 定票时确定旅客机位，并返回。

11 xx项目.项目目标

接口规范

<模块1 API>

 描述

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

 集成和部署

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

Interface1

 Function1

string function1(int param1, string param2, …)

param1 - param2 -

 Function2

string function2(int param1, string param2, …)

param1 - param2 -

Interface2

12 xx项目.项目目标

<模块2 API>

<模块3 API>

<数据库API>

定义数据库存储过程接口

13 xx项目.项目目标

模块设计

Module1设计

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

模块设计描述

模块界面描述

14 xx项目.项目目标

Module2设计

15 xx项目.项目目标

附录

第三方组件

Delphi组件 组件名称

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

版本 用途

16 xx项目.项目目标

参考资料

Design Pattern -

附加文档

文档名称 项目计划表 数据库定义 ***

文件名 Wind.net.plan.mpp X****.sql 描述 项目时间规划 数据库定义脚本

17