需求分析说明书、概要设计说明书、详细设计说明书部分样例

作者：rjgczj 出处：csai论坛

以下是需求分析说明书、详细设计说明书、概要设计说明书样例，需要的朋友来信联系。rjgczj@

XX系统概要设计说明书

目录

1. 文档介绍 1

1.1 文档目的 1

1.2 文档范围 1

1.3 读者对象 1

1.4 参考文献 1

1.5 术语与缩写解释 1

2. 系统概述 2

3. 设计约束 2

3.1需求约束 2

3.2隐含约束 2

4. 设计策略 3

4.1扩展策略 3

4.2复用策略 3

4.3折衷策略 3

5．系统总体结构 3

5.1、系统总体结构 3

5.2、子系统功能及接口 4

6. 子系统的结构与功能 5

6.1、TERMSERV 5

7. 功能需求追溯 5

8. 环境的配置 5

9．其它 6

附录 6

A、 与主机接口 6

B、与终端接口 6

1. 文档介绍

1.1 文档目的

编写该文档的目的在于从总体设计的角度明确xxxx系统的功能和处理模式，明确与银联的接口，使系统开发人员和产品管理人员明确产品功能，可以有针对性的进行系统开发、测试、验收等各方面的工作。

1.2 文档范围

1.3 读者对象

该文档的读者为用户代表、软件分析人员、开发管理人员和测试人员。

1.4 参考文献

《xxxx系统需求说明书》

1.5 术语与缩写解释

无

2. 系统概述

XX系统是以触摸屏为主要交互工具，帮助用户以自助方式做业务查询。本系统的主要功能包括：话费查询、新业务介绍、网点分布查询、自助终端分布查询、电信新闻、交易监控、设备维护和监控等。本系统的设计目标是保证系统可以7*24小时安全、高效无故障运行；业务人员可以轻松完成设备和交易的监控、管理工作；报表种类齐全，可以满足业务人员各种帐务需求。

3. 设计约束

3.1需求约束

* 本系统应当遵循的标准

数据命名的规则遵循《C语言编程规约》中相关的规定；

* 软、硬件环境

本系统共包括联机处理和系统监控2大模块。

联机模块基于C/S结构，采用AIX操作系统，informix数据库，用ESQL/C语言开发，服务器采用PC SERVER；

监控模块基于B/S结构，采用WIN9X/2000/XP操作系统，使用ASP.NET开发。

* 接口/协议

系统与自助终端和电信主机之间的通讯使用TCP/IP协议；

与自助终端的接口见附录A、与自助终端接口

与电信主机的接口见附录B、与电信接口

* 用户界面

监控部分使用WINDOWS图形化界面，保证中专以上文化程度的人员可以无障碍操作。

* 软件质量

正确性：系统必须交易能够被正确处理；

健壮性：系统应能够7*24小时无故障运行；

效率：系统可以支持100个终端同时发起交易，处理交易的时间不超过10秒钟；

易用性：监控界面应采用图形化操作方式，便于业务人员操作；

安全性：报文中的关键数据域以密文的方式传输；

可扩展性：应该充分考虑到将来交易的修改或增加，避免需求变更时大规模修改程序；

3.2隐含约束

使用监控管理功能的人员是银行的业务人员，他们具有较强的业务技能和基本的电脑知识，对他们提供的操作界面应保证他们经过简单培训后无障碍的操作；

报表应该可以在多种操作系统上浏览、打印；

系统应提供审记追踪功能；

应该把有可能变动的参数存放到配置文件或数据库中，保证修改参数的灵活性。

4. 设计策略

4.1扩展策略

该系统是事务处理型系统，将来功能的扩展主要是指增加新的交易。为了方便本系统在将来扩展功能，在做系统设计时应采取如下策略：

为了保证增加新的功能或接口变更时程序改动规模最小化，应该使用报文格式配置文件解析、组织报文； 为了保证系统的灵活性，应该把可变参数保存到配置文件中；

XX系统详细设计说明书

目录

第一章 引言 1

1.1 概述 1

1.2 背景 1

1.3 定义 1

1.4 参考资料 1

1.5 术语与缩写解释 1

2. 程序结构 2

2.1 模块汇总表 2

3. 程序设计说明 2

3.1 终端通讯子系统 2

3.1.1 子系统功能说明 2

3.1.2 子系统流程图 3

3.1.3 子系统模块设计说明 5

4. 数据结构设计 5

4.1 终端档案表 TERMFILE 5

5. 接口设计 5

5.1 与自助设备接口 5

5.2 与主机接口 6

5.3 内部接口 6

第一章 引言

1.1 概述

编写

XX产品详细设计说明书的目的在于从详细设计的角度明确XX项目的业务品种、功能范围，明确与业务主机/终端系统的接口和业务处理模式，使系统开发人员和产品管理人员明确产品功能，可以有针对性的进行系统开发、测试、验收等各方面的工作。

1.2 背景

系统名称：XX系统

任务提出者：XXX

开发者：XX部门

用户：XX电信

1.3 定义

1.4 参考资料

《项目开发计划书》

《产品需求分析说明书》

《系统总体设计说明书》

1.5 术语与缩写解释

2. 程序结构

2.1 模块汇总表

终端通讯子系统模块名称功能简述readdata接收终端请求报文writelog把报文写入日志setsockscoket设置解析/组织报文以及报文分流模块名称功能简述unpack_c解析终端请求报文printstruct_c输出解吸后的报文checkpackage报文合法性检查pack_c组织应答报文：：：：

3. 程序设计说明

3.1 终端通讯子系统

3.1.1 子系统功能说明

建立TCP/IP 服务器侦听从来自自助设备端的连接请求。

为一个侦听到的连接创建一个进程，负责该连接上的接收和发送，并将接收和发送的原始数据写入LOG文件。

将接收到的数据送到队列1，从队列2取数据进行用于发送。

实现子系统功能程序列表：

termserv.c

子系统接口描述:

输入：终端请求报文、解析/组织报文以及报文分流模块产生的应答报文

输出：向解析/组织报文以及报文分流模块输出终端请求报文、向终端输出应答报文、向日志文件输出接收到的数据

3.1.2 子系统流程图

第一章 引言.... 1

1.1 编写目的... 1

1.2 项目背景... 1

1.3 基本定义... 1

第二章 产品概述.... 2

2.1 系统功能... 2

2.2 运行环境... 2

2.3 用户的特点... 2

2.3 条件与限制... 2

第三章 功能需求.... 3

3.1 功能划分... 3

3.2 功能描述... 3

4.3 软件接口... 4

4.4 故障处理... 4

第四章 其它需求.... 5

4.1 应用环境... 5

4.2 其它要求... 5

第一章 引言

1.1 编写目的

编写该文档的目的在于明确XX系统的用户需求，使得软件开发人员与用户对待开发软件的需求有统一的、无二义性的认识。该文档所描述的内容，可作为软件确认测试的依据。该文档的读者为用户代表、软件分析人员、开发管理人员和测试人员。

1.2 项目背景

见《XX项目启动会议记要》

1.3 基本定义

第二章 产品概述

2.1 系统功能

序号

功能名称

优先级

简要描述

1联机功能

高

解决实时交易问题

2管理监控功能

高

解决终端日常维护问题

2.2 运行环境

软件平台：服务器为AIX UNIX 4.3.3操作系统、informix数据库；

监控端为WINDONS 98/2000/XP操作系统。

硬件平台：服务器为IBM RS6000系列主机；

监控端为PC机。

2.3 用户的特点

由于使用自助终端的人员是广大市民，所以自助终端的操作界面应满足初中以上文化程度的人无障碍的操作；

使用监控管理功能的人员是业务人员，他们具有较强的业务技能和基本的电脑知识，对他们提供的操作界面应保证他们经过培训后无障碍的操作。

2.3 条件与限制

本次开发的期限为2002-2-5开始，2002-3-5结束；

议采用SOCKET通讯协议；

主机端的接口由主机端给出，不可更改；

与终端的接口由公司与终端厂家协商。

 

第二篇：(需求分析+概要设计+详细设计)文档简单范例

软件开发文档

项目名 ： “通讯录”

版 本： α测试版

作 者： ccba

编写时间：2001-8-20

文档内容：

1 需求规格说明书

2 概要设计说明书

3 详细设计说明书

文档号IM00101

需求规格说明书

1、引言：

1.1 编写目的

本文档的编写是为了确定待开发软件的功能、性能、数据、界面的需求。

1.2 项目背景

“通讯录”软件是为了提供一种功能完备，易于操作、界面美观的优秀软件。该软件由蔡文亮单独开发完成。

1.3 定义

需求规格说明书采用参考资料②标准

1.4 参考资料

①薛华成 《管理信息系统（第三版）》清华大学出版社1999.5

②郑人杰、殷人昆、陶永雷《实用软件工程（第二版）》清华大学出版社1997.4

③周之英 《现代软件工程（基本方法篇）》 科学出版社 2000.1

2、功能需求

该软件由四个主功能模块和一个扩展功能模块构成，各功能模块中规定的均为软件的基本功能，在开发过程中，开发人员可根据实际情况在满足基本功能需求的前提下增加新功能，但必须详细编写相关文档。

2.1录入、修改功能模块

该功能块主要用于数据库的数据录入和修改，考虑到通讯录的实际需要，可以放松对数据库完整性结束的控制，但从减少数据库的角度来考虑，不容许有完全相同的纪录出现（考虑的合并，相同的纪录项）。

2.2查询功能块

本功能模块是最重要的功能块，对通讯录的操作最主要部分就是查询操作。

本功能块要求有如下功能：

1）按数据库各个属性查询

2）按数据库各个属性之间的逻辑组合查询

如：查询名称为“鸭子”且年龄为20岁的详细情况

（SQL语句表示）SELECT *

FROM MESSAGER

WHERE NICKNAME=“鸭子”

AND AGE=20

3）按某一属性的数值范围查询及其逻辑组

如：查询年龄在20至35岁间的详细情况

（SQL语句表示）SELECT *

FROM MESSAGER

WHERE AGE BETWEEN 20 AND 35

4）模糊查询

同时我们要求查询结果可以按用户要求的格式来显示，如：用户能调整显示属性的个数和组合。

2.3系统安全块

通讯录的信息是个人隐私，故在软件中加入必要的安全措施。主要有以下三点：

1）登录帐号和密码的管理

2）帐户权限的控制

3）对部分登录帐号隐藏部分内容

2.4系统设置块

本部分内容主要是对软件使用时一些设置使其更利于软件的使用：主要包括以下四个方面：

1）系统界面背景和色彩设置（模仿WINNAP）

2）闹铃功能开关，即实现朋友生日提醒功能

3）记录内容项（即数据库修改通讯录上的内容项）

4）历史记录，用户可以选择是否记录下何人何时使用过该软件

2.5扩展功能块

1）网络功能：通过OLE/COM接口的调用，实现E-mail软件调用。

2）帮助文档的制作（On-line help）

3、性能需求

3.1效率需求：要求软件的启动时间不超过3秒，最好控制在2秒内，每次查询的时间不超过3秒，其它各项操作完成时间在1秒限内。

3.2空间需求：视数据库大小而定，一般在10M以内。

4、数据描述

4.1E-R图

4.2数据项

数据项：姓名

含义说明：标识记录信息

别名： 无

类型： 字符串

长度： 20

取值范围： 中文字符 或 西文字符

与其他数据项的逻辑关系： 允许重名现象

数据项：系统色彩标志位

含义说明： 系统是否有色彩设置

别名： 无

类型： 布尔型

取值含义：T是 F否

与其他数据项的逻辑关系：若系统有色彩设置，启用系统色彩数据

数据项：系统色彩

含义说明： 系统界面色彩

别名： 无

类型： 长整形

与其他数据项的逻辑关系：若系统有色彩设置，启用系统色彩数据

数据项：系统背景标志位

含义说明： 系统是否有背景设置

别名： 无

类型： 布尔型

取值含义：T是 F否

与其他数据项的逻辑关系：若系统有背景设置，启用系统背景数据

数据项：系统背景

含义说明： 系统界面背景

别名： 无

类型： 长整形

与其他数据项的逻辑关系：若系统有背景设置，启用系统背景数据

数据项： 系统提醒功能开关

含义说明： 系统是否有提醒功能设置

别名： 无

类型： 布尔型

数据项： 系统跟踪审计功能开关

含义说明： 系统是否有跟踪审计功能设置

类型： 布尔型

数据项：系统权限矩阵

含义说明： 不同权限级别的权限设置

类型： 4×4布尔型矩阵

数据项： 出生日期

含义说明： 记录项表示的人物的出生日期

类型： 日期型

数据项： 性别

含义说明： 记录项表示的人物的性别

类型： 布尔型

取值说明： T男 F女

数据项： 联系方式

含义说明： 记录项表示的人物的联系方式

数据项： 账号

别名： 用户账号

含义说明： 用户登录系统使用的身份鉴别码

类型： 字符串

长度： 10

取值范围： 数字、中文字符和西文字符

与其他数据项的逻辑关系：和密码数据项一一对应

数据项： 密码

别名： 用户密码

含义说明： 用户用于登录系统的和用户账号相应的密码

类型： 字符串

长度： 10

取值范围： 数字、中文字符和西文字符

与其他数据项的逻辑关系：和账号数据项一一对应

数据项： 权限

含义说明： 用户账号的权限

类型： 短整形

与其他数据项的逻辑关系：权限矩阵用于设置本数据项

4.3数据结构

数据结构：系统数据

含义说明：记录系统的设置数据

组成： 系统数据结构=系统色彩标志位+系统色彩+系统背景标志位+系统背景+系统提醒功能开关+系统跟踪审计功能开关+系统权限矩阵

数据结构：记录项数据

含义说明：记录通信录中的记录信息

组成：记录项数据结构=姓名+性别+年龄+联系方式

数据结构： 用户数据

含义说明： 用户登录系统使用数据

组成： 用户数据=账号+密码+权限

4.4数据流

4.5数据存储

注：4.数据流 5.数据存储 略

4.6主题数据库

①记录主数据库 存储记录项数据

②安全数据库 存储用户账号、密码、权限信息

③系统数据库 存储系统数据

4 历史记录数据库 存储软件使用的历史情况

5、运行需求

5.1 用户界面

简洁明快、造型新颖、有用户设置功能

5.2 硬件接口

I/O设备：显示器、打印机、鼠标、键盘

5.3 故障处理

显示故障信息，有一定自动纠错功能

6、安全需求

应提供基本的安全控制，包括：账户密码控制、用户权限控制、跟踪审计控制

文档号IM00102

概要设计说明书

1、引言：

1.1 编写目的

概要设计是为了说明系统的功能分配，模块划分，程序的总体结构，输入输出及接口设计、运行设计、数据结构设计和出错处理设计等，为详细设计奠定基础。

1.2 项目背景

该项目由信息管理系九八级学生蔡文亮同学单独开发，拟在作为软件分发出去。

1.3 定义

本说明书中业务流程图（TFD）采用薛华成的《管理信息系统（第三版）》 p.339标准。

1.4 参考资料

①薛华成 管理信息系统（第三版）清华大学出版社1999.5

②需求规格说明书 文档号IM00101

③郑人杰、殷人昆、陶永雷《实用软件工程（第二版）》清华大学出版社，1997.4

2、任务概述

2.1 目标：作为一个简便易用的自由软件

2.2 运行环境：WINDOWS 95/98/ME/NT/2000

Paradox 数据库管理系统

硬件环境：1BM-PC机，笔记本电脑

2.3 开发方案：

利用Borland C++ Builder 5.0单独完成试用版的开发工作。

3、总体设计

3.1 处理流程（如图1）

另：系统启动时有登录过程，登录成功后有系统的配置过程。

3.2 总体结构和模块外部设计

为方便阅读，现将软件的总体结构图示如下：（如图2）

尤其拟用RAD（Rapid Application Development）BCB进行开发，故各模块之间功能相对独立，各模块共用的数据有记录数据库、安全数据库和系统数据。

4、接口设计

4.1 外部接口

用户界面：用户界面要求较活泼，符合小软件的风格。

软件接口：无

硬件接口：无特殊硬件接口，用户采用键盘、显示器、鼠标 作为主要设备，查询结果也可用打印机输出。

4.2 内部接口

各模块之间并无直接的通信关系，通过系统数据来传递信息。

5、数据结构设计

本系统中自行定义的数据结构是系统数据作用是描述系统设置，其逻辑结构和含义如下：（用类C语言描述）

Class SystemData

{//系统数据定义

bool ColorFlag；//是否用缺省的配置 T不用F用

long SColor；//用户有定义色彩

bool PictureFlag；//是否使用背景图案 T是F否

char SPicture[100]；//背景图案位置

bool Alarm；//提醒功能开关 T开 F关

bool Record；//跟踪审计功能开关 T开 F关

bool Grant [4] [4]；//权限矩阵 T有权限 F无权限

};

该数据结构的物理设计从略

该数据结构记录系统设置系统启动时使用,系统设置以及安全设置模块对其修改

6、运行设计

6.1 运行模块的组合

该系统采用事件驱动思想，要求各模块间事件执行，严格并执行系统及两个以上的模块。

6.2 运行控制

各模块的运行采用事件驱动的方式，在WINDOWS主控窗体（本系统中称之为控制面板）的控制下，由事件驱动运行。

7、出错处理

本系统中，出错主要是由于数据库操作失误引起软件运行出错，其它出错可能不大，故出错处理只是简单的WINDOWS风格的告知窗口，并由系统处理出错情况。

8、安全保密设计

在软件的一级采用帐号密码、权限控制、审计跟踪（可选）三种方式进行安全保密。

文档号IM 00103

详细设计说明书

1、引言

1.1 编写目的：在概要设计的条件下，继续工作，为编码人员提供编码依据，同时也会测试维护人员提供依据。

1.2 项目背景

作为自由软件的一个项目。

1.3 定义

本文档格式按参考资料①P.483

1.4 参考资料

①郑人杰、殷人昆、陶永雷《实用软件工程（第二版）》清华大学出版社 1997.4

②需求规格文档说明书 文档号IM00101

③详细设计说明书 文档号IM00102

2、总体设计

2.1 要求概述

2.2软件结构

3、程序描述

3.1 录入修改功能模块

3.1.1功能：对记录数据库进行插入和修改操作

3.1.2性能：要求对响应：响应时间不超过1秒

3.1.3 输入项目：①原始数据

②修改信息

3.1.4输出项目：①完成信息 ②出错信息

3.1.5 并法 无特殊并法

3.1.6 程序逻辑

3.1.7接口：用户界面设计

3.1.8测试要点：①对输出信息是否及时输出，输出内容是否正确的测试

②对输入信息的完整性约束条件的测试

3.2 查询模块

3.2.1功能：根据用户给出条件查询记录Drs中的信息，显示查询结果，并可打印查询结果

3.2.2性能：①查询过程不超过2秒钟，尽量缩短查询时间

②给出适当的出错控制

3.2.3输入项目

①查询条件

②查询系统

3.2.4输出项目

查询结果、报表

3.2.5并法 无特殊并法

3.2.6程序逻辑

3.2.7接口

界面设计

3.2.8测试要点

①SQL语句生成机构的健壮性，是否会产生不可执行的SELECT语句，引起查询失败，系统出错。 ②报表生成机构是否会显示查询的手段。

3.3安全设置模块

3.3.1功能:

①登录帐号和密码程序

②帐户权限的范围控制

③控制是否隐蔽部分内容

注:本功能模块只允许admin帐号以及admin授权帐号管理

Ⅰ、帐号密码：每用户均需一注册的帐号及相应密码进行登录，系统有管理员帐号admin，初始密码是123456。

Ⅱ、权限控制，设有0～4级权限。权限的控制程度为功能模块，用户可根据实际情况设定权限的实际权限。

Ⅲ、跟踪审计，可选功能，功能为记录用户登录情况和操作情况。

3.3.2性能

要求各项功能设置即时生效

3.3.3 输入项目

安全设置为有关信息及安全设置的更改信息

3.3.4输出项目

无

3.3.5程序逻辑

3.3.6界面设计

3.3.7 测试要点：

①各种安全设置是否生效

②安全设置可否保存

3.4 系统设置模块

3.4.1 功能

1 系统界面背景与色彩设置

2 闹铃提醒功能

3 记录字段修改，4 即记录数据库元数据的修改

5 历史记录设定

3.4.2 性能

要求 完成时间不超过2 sec

3.4.3 输入项目

系统设置信息

3.4.4 输出项目

无

3.4.5 程序逻辑

3.4.6 界面设置

3.4.7 测试要点

1 各项设置是否生效

2 设置可否保存

3.5系统启动流程

3.6 系统界面设计