Chinaunix

标题: 需求分析说明书、详细设计说明书、概要设计说明书样例 [打印本页]

作者: ouyang0322 时间: 2007-01-18 09:32
标题: 需求分析说明书、详细设计说明书、概要设计说明书样例
以下是需求分析说明书、详细设计说明书、概要设计说明书样例
需要详细资料的去
http://bbs.csai.cn/BBS/view.asp?ID={CA9329C0-93C5-4417-9170-452FF61E8CDB}&page=1下载

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通讯协议；

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

与终端的接口由公司与终端厂家协商。
需要详细资料的去
http://bbs.csai.cn/BBS/view.asp?ID={CA9329C0-93C5-4417-9170-452FF61E8CDB}&page=1下载

作者: 小菜9527 时间: 2007-01-18 09:37
我这边接口说明书是单独的文档米有附录在概设里面，原因是需求评审和设计评审是两个阶段
单独成立文档便于以后开发过程中版本升级！哈哈
我觉的第三方的接口是不是应该算是需求，因为毕竟是别人提供的东西了！

作者: 山中无老虎 时间: 2007-01-18 11:22

原帖由 小菜9527 于 2007-1-18 09:37 发表
我这边接口说明书是单独的文档米有附录在概设里面，原因是需求评审和设计评审是两个阶段
单独成立文档便于以后开发过程中版本升级！哈哈
我觉的第三方的接口是不是应该算是需求，因为毕竟是别人提供的东西了！

概念好象有些问题。你说的第三方接口是指什么呢？

作者: 山中无老虎 时间: 2007-01-18 11:23
我觉得这些东西都是活的，没有必要非按一定的格式来说明。

作者: la.lune 时间: 2007-03-08 12:04
这个没什么规格了产品不同行业不同流程大相径庭
每个公司都有自己一套流程当然spec差的就更远了
一般只要能行的通以后的工作可以顺利进行就OK

作者: zsj_0927 时间: 2007-04-11 14:42
写过及个概要设计，但都是按照自己想法写的。

作者: sytpb 时间: 2010-05-14 18:17
mark

作者: leoflash 时间: 2010-06-23 09:20
{:2_166:}{:2_167:}{:2_167:}{:2_167:}

作者: fanfankie 时间: 2010-06-30 16:45
提示: 作者被禁止或删除内容自动屏蔽

作者: blackuhlan 时间: 2010-09-18 14:58
组织过程资产应该包括这些文档模板，至于如何写，怎么样才算写好了，由最佳实践来指导。不同的企业，为了企业内部规范的统一，交流方便等原因，会制定不同的模板。况且，对于大的项目和小的项目，就算是同样目的的一个文档，也可能会写成不同的形式。

作者: abc3214 时间: 2012-08-24 19:58
应该把有可能变动的参数存放到配置文件或数据库中，保证修改参数的灵活性

欢迎光临 Chinaunix (http://bbs.chinaunix.net/)