概要设计规格说明书范例
(完整word版)概要设计说明书模板
软件概要设计说明书模板（V1.0）文档编号：文档名称：编写：编写日期：审核：审核日期：批准：批准日期：<项目名称>软件概要设计说明书（版本号）文档编号：项目名称：编写：编写日期：审核：审核日期：批准：批准日期：文档修订记录目录第1章引言 (6)1.1 编写目的 (6)1.2 预期读者 (6)1.3 编写背景 (7)1.3.1系统名称及版本号 (7)1.3.2任务提出者 (7)1.3.3任务承接者及实施者 (7)1.3.4使用者 (7)1.3.5与其它系统的关系 (7)1.4 文档结构 (8)1.5 术语定义 (8)1.6 电子文档编写工具 (8)1.7 参考资料 (8)第2章系统概述 (9)2.1系统目标 (9)2.2设计原则 (9)2.3运行环境 (9)2.3.1硬件平台 (9)2.3.2软件平台 (9)2.3.3网络体系结构 (9)2.4系统整体结构概述 (10)2.5需求功能覆盖关系说明 (10)2.6关键技术 (10)第3章系统功能说明 (11)3.1系统功能概述 (11)3.2系统外部接口 (11)3.3子系统功能说明 (12)3.4模块层次结构图 (13)3.5模块1 (13)3.5.1模块功能描述 (13)3.5.2功能模块的主要流程说明 (13)3.5.3功能点名称1 (13)第4章数据库设计 (15)第5章用户界面设计 (15)5.1基本原则 (15)5.2设计规范 (15)第6章出错处理设计 (15)6.1出错信息 (15)6.2补救措施 (15)第7章需求可追踪性 (16)附录 (17)代码表手册 (17)设计与编程规范、惯例及约定 (17)1数据库设计规范 (17)2编程规范 (17)3用户界面规范 (17)第1章引言1.1 编写目的【说明】本文档是以《软件需求分析说明书》为基础，进一步就《软件需求分析说明书》中的功能从计算软件实现的角度给出的设计描述。
即是对需求分析说明书中的功能以计算机软件设计的角度，对上述功能的实现进行合理的功能模块的划分、对上述功能模块的所包含的功能点进行描述和说明，必要的情况下可以程序流程图的方式进行说明，这些功能模块的划分和设计是以最终实现《软件需求分析说明书》的功能描述的要求为原则的；它将作为项目验收时重要的标准和依据。
概要设计说明书示例
【项目名称】概要设计说明书修订历史记录A - 增加M - 修订D - 删除【模板使用必读：模板内容和页眉中【】包含内容为指导性的待替换文字，请在使用中替换为具体内容，或删除。
文件提交时不得再含有这些内容。
】目录1 引言........................................................1.1编写目的..............................................1.2背景..................................................1.3术语与缩写解释........................................1.4参考资料.............................................. 2概述........................................................2.1系统任务..............................................2.1.1 .......................................... 系统目标2.1.2 .......................................... 运行环境2.1.3 .................................... 与其它系统关系2.2需求规定..............................................2.2.1 .......................................... 功能需求2.2.2 ...................................... 非功能性需求2.2.3 ........................................ 约束和假定3总体设计....................................................3.1基本设计概念和处理流程................................3.2软件系统结构..........................................3.2.1 ............................................ 模块A3.2.2 ............................................ 模块B3.3功能需求与系统模块的关系..............................3.4接口设计..............................................3.4.1 .......................................... 用户接口3.4.2 .......................................... 外部接口3.4.3 .......................................... 内部接口3.5数据结构设计..........................................3.5.1 .................................. 逻辑结构设计要点3.5.2 .................................. 物理结构设计要点3.5.3 .............................. 数据结构与程序的关系4运行设计....................................................4.1运行模块组合..........................................4.2运行控制..............................................4.3运行时间..............................................5系统出错处理设计............................................5.1出错信息..............................................5.2补救措施..............................................6系统维护设计................................................7尚未解决的问题..............................................1引言1.1编写目的【给出项目概要设计说明书的编写目的，同时指明读者对象。
概要设计说明书模板示例doc
精心整理重庆大学虎溪校区后勤项目目录1引言 ........................................................................................................ 错误！未指定书签。
1.1编写目的......................................................................................... 错误！未指定书签。
1.2背景................................................................................................. 错误！未指定书签。
1.3基线................................................................................................. 错误！未指定书签。
1.4范围................................................................................................. 错误！未指定书签。
1.5定义................................................................................................. 错误！未指定书签。
1.6参考资料......................................................................................... 错误！未指定书签。
2总体设计................................................................................................. 错误！未指定书签。
概要设计说明书 (2)
概要设计说明书1. 引言概要设计说明书旨在对系统或项目的整体结构、模块划分进行概括性的描述和解释，详细阐述系统设计的思路、目标和原则。
本文档将介绍系统的基本概念、架构设计、模块划分、接口设计等关键内容，以帮助开发人员更好地理解系统的整体设计思路和实现方法。
2. 系统概述本系统是一个xxx（系统名称）的xxx（系统类型），旨在xxx（系统目标）。
系统包括xxx个模块，分别负责xxx功能。
系统采用xxx（架构模式），拥有良好的可扩展性、可维护性和可测试性。
3. 功能需求3.1 功能1功能1的主要目标是xxx。
实现这一功能的关键步骤包括：xxx（详细描述功能实现的步骤或算法）。
对应的模块为xxx模块，该模块负责xxx（模块的职责描述）。
3.2 功能2功能2的主要目标是xxx。
实现这一功能的关键步骤包括：xxx（详细描述功能实现的步骤或算法）。
对应的模块为xxx模块，该模块负责xxx（模块的职责描述）。
…4. 结构设计4.1 总体结构系统的总体结构如下图所示：插入总体结构示意图系统分为xxx个核心模块，分别为xxx。
每个模块之间通过xxx（接口协议或通信方式）进行通信和数据交互。
4.2 模块设计4.2.1 模块1模块1的主要职责是xxx。
模块1包含如下子模块：•子模块1：负责xxx；•子模块2：负责xxx；•…4.2.2 模块2模块2的主要职责是xxx。
模块2包含如下子模块：•子模块1：负责xxx；•子模块2：负责xxx；•……5. 接口设计系统的各模块之间通过接口进行数据传输和方法调用。
本节将描述系统的主要接口及其定义。
5.1 接口1接口1用于xxx的数据传输和方法调用。
接口1的定义如下：public interface Interface1 {// 方法1的说明void method1();// 方法2的说明int method2(String param);}5.2 接口2接口2用于xxx的数据传输和方法调用。
概要设计说明书实例
概要设计说明书实例概要设计说明书目录1.引言1.1 编写目的1.2 参考资料1.3 读者对象2.概述2.1 项目背景2.2 目标和范围2.3 功能需求2.4 非功能需求2.5 术语定义3.系统架构设计3.1 整体架构3.2 模块划分3.3 数据流图3.4 接口设计4.数据库设计4.1 数据库模型 4.2 数据库表设计4.3 数据库操作5.界面设计5.1 用户界面5.2 界面元素5.3 界面交互6.功能设计6.1 功能16.2 功能26.3 功能37.性能设计7.1 响应时间7.2 并发处理7.3 资源利用8.安全设计8.1 访问控制8.2 数据保护8.3 安全性检测9.部署设计9.1 系统环境9.2 系统安装9.3 系统配置9.4 系统部署10.维护设计10.1 日志记录10.2 故障恢复10.3 系统升级10.4 系统维护11.附录附录A：数据词典附录B：界面原型图附录C：系统流程图附录D：参考文献1.引言1.1 编写目的本概要设计说明书旨在对X项目进行概述并详细说明涉及到的设计方案和决策，以便开发团队和其他利益相关方了解系统的整体架构和设计。
1.2 参考资料列出使用的参考资料，如需引用的标准、相关文档和技术资料等。
1.3 读者对象本文档的主要读者对象为项目经理、开发团队成员和其他相关利益相关方，包括测试人员、部署人员等。
2.概述2.1 项目背景简要介绍项目的背景和目标，包括项目的发起原因以及解决的问题或提供的服务。
2.2 目标和范围明确项目的目标和范围，包括项目的主要功能和非功能需求，以及所支持的业务流程和用户需求。
2.3 功能需求详细描述系统支持的各个功能模块及其功能要求，包括输入、输出、处理逻辑等。
2.4 非功能需求列出系统的非功能性需求，如性能要求、安全要求、可用性要求等。
2.5 术语定义解释和定义在本文档中使用的术语，以便读者理解。
3.系统架构设计3.1 整体架构描述系统的整体架构，包括系统的分层结构、模块划分等。
概要设计说明书范例及
X X X X X X概要设计说明书张三、李四、王五1．引言1．1编写目(de)在本机票预定系统项目(de)前一阶段,也就是需求分析阶段中,已经将系统用户对本系统(de)需求做了详细(de)阐述,这些用户需求已经在上一阶段中对航空公司、各旅行社及机场(de)实地调研中获得,并在需求规格说明书中得到详尽得叙述及阐明.本阶段已在系统(de)需求分析(de)基础上,对机票预定系统做概要设计.主要解决了实现该系统需求(de)程序模块设计问题.包括如何把该系统划分成若干个模块、决定各个模块之间(de)接口、模块之间传递(de)信息,以及数据结构、模块结构(de)设计等.在以下(de)概要设计报告中将对在本阶段中对系统所做(de)所有概要设计进行详细(de)说明.在下一阶段(de)详细设计中,程序设计员可参考此概要设计报告,在概要设计对机票预定系统所做(de)模块结构设计(de)基础上,对系统进行详细设计.在以后(de)软件测试以及软件维护阶段也可参考此说明书,以便于了解在概要设计过程中所完成(de)各模块设计结构,或在修改时找出在本阶段设计(de)不足或错误.1．2项目背景机票预定系统将由两部分组成：置于个旅行社定票点(de)前台客户程序,以及置于航空公司(de)数据库服务器.本系统与其他系统(de)关系如下：（航空公司） 飞机1．3 定义1．3．1 专门术语SQL SERVER: 系统服务器所使用(de)数据库管理系统（DBMS ）. SQL: 一种用于访问查询数据库(de)语言事务流：数据进入模块后可能有多种路径进行处理. 主键：数据库表中(de)关键域.值互不相同. 外部主键：数据库表中与其他表主键关联(de)域. ROLLBACK: 数据库(de)错误恢复机制. 1．3．2 缩写系统：若未特别指出,统指本机票预定系统.SQL: Structured Query Language （结构化查询语言）. ATM: Asynchronous Transfer Mode (异步传输模式).1．4 参考资料以下列出在概要设计过程中所使用到(de)有关资料：1．机票预定系统项目计划任务书浙江航空公司 1999/32．机票预定系统项目开发计划软件开发小组 1999/33．需求规格说明书软件开发小组 1999/34．用户操作手册（初稿）软件开发小组 1999/45．软件工程及其应用周苏、王文等天津科学技术出版社1992/16．软件工程张海藩清华大学出版社 1990/117．Computer Network文档所采用(de)标准是参照软件工程导论沈美明着 (de)“计算机软件开发文档编写指南”.2．任务概述2．1 目标2．2 运行环境系统将由两部分程序组成,安装在各旅行社客户机上(de)客户程序及航空公司内(de)数据服务器程序.根据调研得知所有旅行社(de)计算机配置均在Pentium 133级别以上,客户程序应能够在Pentium 133级别以上, Win NT环境下运行.2．3 需求概述浙江航空公司为方便旅客,需开发一个机票预定系统.为便于旅客由旅行社代替航空公司负责为旅客定票,旅行社把预定机票(de)旅客信息,包括姓名、性别、工作单位、身份证号码、旅行时间、旅行目(de)地,输入机票预定系统(de)客户端程序,系统经过查询航空公司内(de)航班数据服务器后,为旅客安排航班,印出取票通知.旅客在飞机起飞前一天凭取票通知和帐单交款后取票,系统校对无误后即印出机票给旅客.要求系统能有效、快速、安全、可靠和无误(de)完成上述操作.并要求客户机(de)界面要简单明了,易于操作,服务器程序利于维护. 2．4 条件与限制3． 总体设计3．1 处理流程下面将使用（结构化设计）面向数据流(de)方法对机票预定系统(de)处理流程进行分析.系统可分为两大部分：一、客户机上(de)程序,二、服务器上(de)程序.以下将分别对系统(de)这两大部分进行流程分析： 3．1．1 客户机程序流程客户机上(de)输入信息为旅客资料或帐单号,还包括一个定票/领票选1．读入并确定（定票/领票）它是一个事务处理中心,若输入是定票时转入2 ,输出则转入5.2．读入旅客资料读取所输入(de)旅客资料,并将其格式化,将格式化数据送3.3．检验输入资料检验格式化输入资料,初步检查输入是否有误,它是一个事务处理中心,有误则转2再次读入,检查无误则将数据送4.4．准备服务器数据由格式化旅客资料准备需发送到服务器(de)数据,将准备好(de)数据送7.5．读入帐单号读取所输入(de)帐单号,并将其格式化,将格式化数据送6.6．准备服务器数据由格式化帐单号准备需发送到服务器(de)数据,不同于4,它将准备(de)是帐单号,将准备好(de)数据送7.7．准备网络数据包将数据准备/加密成网络传输数据包.8．网络数据发送将数据包经网络发送到服务器程序, 它是程序与网络(de)接口.9．网络数据接受接受由服务器程序经网络传送到客户机(de)数据包, 它是程序与网络(de)接口.10．解开/判断解开9 所接受(de)数据包,并判断数据是定票数据或是领票数据,它是一事务处理中心,是定票则将数据送11,是领票则将数据送18. 11．定票成功由数据判断定票是否成功,它是一事务处理中心,若定票成功则将数据送11,不成功则将数据送18.12．准备输出数据由接收(de)服务器数据准备输出数据,其中关于帐单(de)数据将送入13,其他包括旅客资料等送入14.13．打印帐单由帐单信息处理帐单格式并打印出帐单.14．输出定位确定在屏幕上显示确定定位及其他信息.15．判断错误由数据判断出错误类型,将类型送到16.16．准备错误语句由具体错误类型准备错误语句,送17.17．输出错误语句在屏幕上显示错误语句.18．领票核对成功由数据判断领票核对是否成功,它是一事务处理中心,若成功则将数据送19,不成功则将数据送15.19．准备机票输出数据由接收(de)服务器数据准备将打印(de)机票数据数,据其中关于帐单(de)机票(de)数据将送入20,其他包括旅客资料等送入14.20．打印机票由机票信息处理机票格式并打印出机票.3．1．2 服务器程序流程下面对各模块（以数字表示）进行功能说明：1． 网络数据接收 接受由客户机程序经网络传送到客户机(de)数据包, 它是程序与网络(de)接口.2． 解开数据 解开/解密打包(de)数据,并将恢复(de)数据格式化送入3. 3． 判断操作由数据判断需要做什么数据库操作,它是一事务处理中心,若为定票操作则将数据送4,若为领票操作则将数据送15.4．准备数据库查询语句 由定票数据准备访问SQL SERVER 数据库所需(de)SQL 语句,送入5.5． 数据库操作 运行SQL 语句,查询并存入数据库,获得相应(de)定票数据,将数据送入6.它需包括初步对查询(de)判断.它必须为乘客安排可抵达目(de)地(de)有座位(de)航班.6． 判断查询是否成功 利用查询所得(de)数据判断定票是否成功,它是一事务处理中心,若为定票操作成功则将数据送7,若不成功则将数据送8.7． 准备回送数据 准备定票成功后需回送客户机程序(de)数据,送16.8．确定原因由查询数据判断定票不成功(de)原因,送9.9．准备回送数据根据不成功(de)原因,准备需送回客户机程序(de)数据,送入16.10．准备数据库查询语句由领票数据准备访问SQL SERVER数据库所需(de)SQL 语句,送入11.11．数据库操作运行SQL 语句,查询并存入数据库获得相应(de)领票数据,将数据送入6.它需包括初步对查询(de)判断.12．判断查询是否成功利用查询所得(de)数据判断领票是否成功,它是一事务处理中心,若为领票操作得到确认则将数据送11,若不成功则将数据送8.13．准备回送数据准备领票确认后需回送客户机程序(de)数据,送16. 14．确定原因由查询数据判断领票不能确认(de)原因,送15.15．准备回送数据根据不成功(de)原因,准备需送回客户机程序(de)数据,送入16.16．准备网络数据包将数据准备/加密成网络传输数据包.17．网络数据发送将数据包经网络发送到服务器程序, 它是程序与网络(de)接口.以上显示(de)各模块数字相同(de)为同一模块；由于事务流处理上(de)便利,将有些功能模块,拆分到各事务流中.3．2 总体结构和模块外部设计下面以结构图来描述机票预定系统(de)软件总体结构.框内注明了模块(de)名字；方框之间(de)直线表示模块(de)调用关系.3．2．1 客户机部分3．2．2 服务器程序部分其中在数据处理、查询下作了省略…只给出了一部分模块,实际上是有两部分,分别对应于定位及确认.功能分配各项模块(de)功能可参照中(de)说明.客户机程序主要有三大块：接收数据、网络通信及输出部分.服务器程序主要也是由三大功能：接收网络数据、数据库操作及发送网络数据部分.服务器程序需与已建立(de)SQL SERVER 数据库互连,其接口将于下面部分阐述.4．接口设计4．1 外部接口4．1．1 用户界面在用户界面部分,根据需求分析(de)结果,用户需要一个用户友善界面.在界面设计上,应做到简单明了,易于操作,并且要注意到界面(de)布局,应突出(de)显示重要以及出错信息.外观上也要做到合理化,考虑到用户多对WINDOW 风格较熟悉,应尽量向这一方向靠拢.在设计语言上,已决定使用 MS VISUAL C++ 进行编程,在界面上可使用VISUAL C++ 所提供(de)可视化组件,向WINDOWS 风格靠近. 其中服务器程序界面要做到操作简单,易于管理.在设计上采用下拉式菜单方式,在出错显示上可调用VISUAL C++ 库中(de)错误提示函数.总(de)来说,系统(de)用户界面应作到可靠性、简单性、易学习和使用4．1．2 软件接口服务器程序可使用VISUAL C++ 提供(de)对 SQL SERVER (de)接口,进行对数据库(de)所有访问.服务器程序上可使用SQL SERVER (de)对数据库(de)备分命令,以做到对数据(de)保存.在网络软件接口方面,使用一种无差错(de)传输协议,采用滑动窗口方式对数据进行网络传输及接收.4．1．3 硬件接口在输入方面,对于键盘、鼠标(de)输入,可用VISUAL C++(de)标准输入/输出,对输入进行处理.在输出方面,打印机(de)连接及使用,也可用VISUAL C++(de)标准输入/输出对其进行处理.在网络传输部分,在网络硬件部分,为了实现高速传输,将使用高速ATM.4．2 内部接口内部接口方面,各模块之间采用函数调用、参数传递、返回值(de)方式进行信息传递.具体参数(de)结构将在下面数据结构设计(de)内容中说明.接口传递(de)信息将是以数据结构封装了(de)数据,以参数传递或返回值(de)形式在各模块间传输.5．数据结构设计5．1 数据库数据结构设计DBMS (de)使用上系统将采用 SQL SERVER, 系统主要需要维护3张数据表：1．航班班次表航班班次表保存了所有从本地起飞(de)班机信息,它(de)主键为航班号.在定位前先查寻座位空数,在定位后将修改座位空数.2．定位信息表定位信息表保存了已定位信息,主键为帐单号,外部主键为航班号.在旅客领票过程时将用到此表,领票后修改是否领票域3．帐单信息/旅客资料表帐单信息/旅客资料表保存已定位(de)旅客信息资料,它(de)主键为旅客身份证号,外部主键为帐单号.主要用于领票时将旅客信息一同返回.4．机位信息表班机号机位信息机位信息表保存各班机各机位定票状况.它(de)外部主键为班机号.主要用于定票时确定旅客机位,并返回.5．2 物理数据结构设计物理数据结构设计主要是设计数据在模块中(de)表示形式.数据在模块中都是以结构(de)方式表示.1．旅客信息1．旅客姓名String用于定票时接收输入,以及领票时服务器返回.2．旅客性别Char2．帐单号可使用一LONG INT 实现.用于领票时接收输入,以及定票时服务器返回.3．飞行目(de)用于定票时接收输入,以及领票时服务器返回. 4． 网络包 用于数据在网络上(de)传输.5．错误信息用于关于错误操作. 6．机票信息用于打印机票准备工作.数据类型可参照上面所述.7． 帐单信息用于打印帐单准备工作.数据类型可参照上面所述.5．3 数据结构与程序(de)关系服务器程序在对定票/领票进行操作时需对数据库数据库数据结构,也就是数据表进行查询和修改：在定票/领票过程中都需要对数据库中(de)所有表,进行联合查询、修改.物理数据结构主要用于各模块之间函数(de)信息传递.接口传递(de)信息将是以数据结构封装了(de)数据,以参数传递或返回值(de)形式在各模块间传输.出错信息将送入显示模块中,机票结构,帐单结构,送入打印准备模块中准备打印格式.1. 航班号 String2. 目(de)地 String3. 起飞时间Date/Time 1. 网络包Head INT1. 错误类型INT1． 航班号2． 目(de)地3． 起飞时间4． 旅客姓名1．帐单号 2．旅客姓名3．身份证号码6．运行设计6．1 运行模块(de)组合客户机程序在有输入时启动接收数据模块,通过各模块之间(de)调用,读入并对输入进行格式化.在接收数据模块得到充分(de)数据时,将调用网络传输模块,将数据通过网络送到服务器,并等待接收服务器返回(de)信息.接收到返回信息后随即调用数据输出模块,对信息进行处理,产生相应(de)输出.服务器程序(de)接收网络数据模块必须始终处于活动状态.接收到数据后,调用数据处理/查询模块对数据库进行访问,完成后调用网络发送模块,将信息返回客户机.6．2 运行控制运行控制将严格按照各模块间函数调用关系来实现.在各事务中心模块中,需对运行控制进行正确(de)判断,选择正确(de)运行控制路径.在网络传方面,客户机在发送数据后,将等待服务器(de)确认收到信号,收到后,再次等待服务器发送回答数据,然后对数据进行确认.服务器在接到数据后发送确认信号,在对数据处理、访问数据库后,将返回信息送回客户机,并等待确认.6．3 运行时间在软体(de)需求分析中,对运行时间(de)要求为必须对作出(de)操作有较快(de)反应.网络硬件对运行时间有最大(de)影响,当网络负载量大时,对操作反应将受到很大(de)影响.所以将采用高速ATM 网络,实现客户机与服务器之间(de)连接,以减少网络传输上(de)开销.其次是服务器(de)性能,这将影响对数据库访问时间即操作时间(de)长短,影响加大客户机操作(de)等待时间,所以必须使用高性能(de)服务器,建议使用 Pentium III 处理器.硬件对本系统(de)速度影响将会大于软件(de)影响.7．出错处理设计7．1 出错输出信息程序在运行时主要会出现两种错误：1、由于输入信息,或无法满足要求时产生(de)错误,称为软错误.2、由于其他问题,如网络传输超时等,产生(de)问题,称为硬错误.对于软错误,须在定票/领票操作成功判断及输入数据验证模块由数据进行数据分析,判断错误类型,再生成相应(de)错误提示语句,送到输出模块中.对与硬错误,可在出错(de)相应模块中输出简单(de)出错语句,并将程序重置.返回输入阶段.出错信息必须给出相应(de)出错原因,例：全部班机座位已满查无此定位信息等.7．2 出错处理对策所有(de)客户机及服务器都必须安装不间断电源以防止停电或电压不稳造成(de)数据丢失(de)损失.若真断电时,客户机上将不会有太大(de)影响,主要是服务器上：在断电后恢复过程可采用 SQL SERVER (de)日志文件,对其进行ROLLBACK 处理,对数据进行恢复.在网络传输方面,可考虑建立一条成本较低(de)后备网络,以保证当主网络断路时数据(de)通信.在硬件方面要选择较可靠、稳定(de)服务器机种,保证系统运行时(de)可靠性.8．安全保密设计由于数据(de)传输上需要通过网络传输,为了客户资料进行保密,需要在网络(de)传输过程中对数据进行加密.这个工作主要是在准备网络包,及解开网络包这两个模块完成,它们各对数据进行加密及解密还原工作.在加密算法选择上将使用RSA 加密算法.具体算法可参照参考资料中Computer Network.9．维护设计维护方面主要为对服务器上(de)数据库数据进行维护.可使用 SQL SERVER (de)数据库维护功能机制.例如,定期为数据库进行Backup,维护管理数据库死锁问题和维护数据库内数据(de)一致性等.。
概要设计说明书实例
1.1编写目的3
1.2背景3
1.3定义3
1.4参考资Βιβλιοθήκη 32总体设计32.1简述3
2.2架构设计4
2.2.1系统逻辑架构图4
2.2.2系统物理架构图4
2.2.3顶层系统包图5
2.2.4业务类包图6
2.2.5子系统关系图6
2.3接口设计6
2.3.1界面框架设计6
2.3.2外部接口设计7
3子系统设计7
+读取用户权限（in用户ID）:Data::权限实体类
页面显示全部权限内容：调用Service：：权限的查询全部权限或通过所属系统查询全部权限，将权限数据显示到页面上。
通过所属系统查询全部权限：调用Service：：权限的通过所属系统查询全部权限，读取某系统下的全部权限数据。
UI:员工管理
+通过D查询员苒口员工!口）:Data员工实体类
+多条件查询员®查询条件对象Data:员工实体类
+查询全部员工：Data员工实体类
+增加员单口Data员工实体类:boolean
+修改员单口Data员工实体类:boolean_
+删除员单口员工!口）:boolean
+员工修改登录密码n员工D,由密码：boolean
3.1基础信息子系统7
3.1.1子系统说明7
3.1.2类图8
3.1.3类说明12
3.1.4界面设计19
3.2我的工作台子系统21
3.2.1子系统说明21
3.2.2类图22
3.2.3类说明26
3.2.4界面设计32
3.3工作进展子系统33
3.3.1子系统说明33
3.3.2类图34
概要设计说明书模板
概要设计说明书模板篇一：概要设计说明书模板XXX项目概要设计说明书公司实施部门：项目经理：生效日期：（文档编号：）目录1. 编制目的 ................................................ ................................................... ........ 错误！未定义书签。
2. 适用范围 ................................................ ................................................... ........ 错误！未定义书签。
3. 文件说明 ................................................ ................................................... ........ 错误！未定义书签。
1. 概述 ................................................ ................................................... . (3)1.1 1.2 1.3 1.4 1.5系统简介 ................................................ ................................................... .............................. 3 系统目标 ................................................ ................................................... .............................. 3 系统设计原则 ................................................ ................................................... ...................... 3 系统运行环境 ................................................ ................................................... ...................... 3 开发环境 ................................................ ................................................... (3)2. 总体结构 ................................................ ................................................... ......................................... 3 2.1系统部署 ................................................ ................................................... (3)系统拓扑结构 ................................................ ................................................... .. (3)2.1.2 系统部署说明 ................................................ ................................................... .............. 4 2.2 软件部署 ................................................ ................................................... (4)3. 数据流程 ................................................ ................................................... ......................................... 4 3.1 3.2 3.3数据流程图 ................................................ ................................................... .......................... 4 数据流程图说明 .................................................................. 4 数据字典 ................................................ ................................................... (4)2.1.14. 系统模块设计................................................. ................................................... ................................. 4 4.1 4.2子系统模块结构图 ................................................ ................................................... .............. 4 子系统模块概要设计 ................................................ ................................................... . (4)5. 数据库设计 ................................................ ................................................... ..................................... 5 5.1 5.2结构概................................................... .............................. 5 表结构 ................................................ ................................................... . (5)6. 永久性数据结构................................................. ................................................... ............................. 6 6.1 6.2 6.3文件组织结构 ................................................ ................................................... ...................... 6 文件结构 ................................................ ................................................... .............................. 6 数据备份、恢复 ................................................ ................................................... (6)7. 系统业务功能设计.......................................................................... 6 7.1 7.2业务内容 ................................................ ................................................... .............................. 7 处理流程 ................................................ ................................................... (7)8. 其它设计 ................................................ ................................................... ......................................... 7 9. 术语表 ................................................ .................(原文来自：小草范文网:概要设计说明书模板)................................................ . (7)XXX项目概要设计说明书文档编号：版本：1. 概述 1.1 系统简介简要描述本系统基本情况。
- 1、下载文档前请自行甄别文档内容的完整性，平台不提供额外的编辑、内容补充、找答案等附加服务。
- 2、"仅部分预览"的文档,不可在线预览部分如存在完整性等问题,可反馈申请退款(可完整预览的文档不适用该条件!)。
- 3、如文档侵犯您的权益，请联系客服反馈,我们会尽快为您处理(人工客服工作时间：9:00-18:30)。
互联网客服Demo系统产品总体设计规格说明书文档修订摘要目录第1章引言 (4)1.1 文档用途 (4)1.2 阅读对象 (4)1.3 名词术语 (4)1.4 参考资料 (5)第2章概述 (6)2.1 系统概述 (6)2.2 系统功能性需求 (6)2.3 系统非功能性需求 (15)2.4 产品目标 (15)2.4.1产品定位 (15)2.4.2产品亮点 (15)2.5 设计约束 (16)第3章系统设计策略 (18)3.1 基础结构 (18)3.2 设计策略 (18)第4章系统体系结构 (20)4.1 系统总体结构 (20)4.2 子系统结构与功能 (20)4.3 系统外部关系图 (38)第5章系统环境 (39)5.1 开发环境 (39)5.2 测试环境 (39)5.3 运行环境 (39)5.4 安装目录 (39)5.5 设计工具要求 (40)第6章关键技术问题 (41)第1章引言1.1 文档用途软件的概要设计是软件设计开发的重要组成部分，它是连接用户需求与系统实现的桥梁。
本文档基于《互联网客服Demo系统》的需求规格说明书编写，软件要完成的功能是搭建互联网客服Demo系统，提供售前演示环境，为客户了解我方产品提供直观的感受、验证互联网客服系统与呼叫中心系统的融合方式和融合效果。
通过这份软件系统概要设计规格说明书详尽说明了该软件产品的设计策略、体系结构、系统环境、关键技术问题，从而对该软件产品的结构的描述。
1.2 阅读对象本文档可能的读者及阅读建议：●用户：重点阅读系统体系结构之4.1节；●开发人员：应全篇认真阅读；●项目经理：重点阅读设计概述与策略；●测试人员：应全篇认证阅读●文档编写人员：重点阅读设计概述。
1.3 名词术语1.4 参考资料互联网客服Demo系统开发需求V0.2第2章概述2.1 系统概述互联网客服Demo系统，是对互联网微博、微信客服系统的Demo实现，以提供demo系统所要实现的诸演示功能，为客户了解我方产品提供直观的感受。
2.2 系统功能性需求2.2.1微信客服2.2.1.1申请客服微信账号如果有可能利用的微信公众测试账号，尽量利用已有账号，如果没有则通过华胜或者摩卡的名义申请。
微信账号名称为“多媒体服务平台”。
2.2.1.2微信客服首次关注提示语用户关注“多媒体服务平台”微信账号后的，首次进入官微界面提供给用户的提示语：“欢迎关注多媒体服务平台官方微信，我们将竭诚为您服务！”2.2.1.3微信客服菜单用户进入“多媒体服务平台”官微客服界面后，下方展示3*5菜单，分别为：“我的账户”-》“我的资料”、“我的账单”、“我的积分”、“我的额度”“产品资讯”-》“最新推荐”、“精彩特惠”、“生活服务”、“抽奖活动”“特色服务”-》“账号绑定”、“人工客服”、“周边网点”、“常见问题”其中，“人工客服”为用户与微信客服坐席直接交流的入口，“账号绑定”提供验证用户身份并绑定用户账号的功能，其他的选项为用户自助服务内容。
2.2.1.4用户身份绑定除用户主动进行“账号绑定”操作外，在未绑定用户的情况下，如果用户进行需要身份信息的操作，例如：查询“我的资料”、“我的账单”、“我的积分”、“我的额度”；以及进入“人工客服”时。
用户身份绑定界面上，有“账号”、“密码”、“验证码”输入框，点击“绑定”按钮，提交后台进行绑定。
后台验证用户身份后，将用户的微信openId与账号绑定起来，后续再使用需要身份信息的服务时，无需再次验证身份。
2.2.1.5用户与客服坐席的在线沟通在完成用户身份绑定的情况下，用户可以与坐席进行在线沟通。
如果用户还未绑定身份，则先弹出上节的界面进行身份绑定。
用户在微信、微博上与坐席在线沟通的界面使用微信、微博文字交互界面即可。
客服人员在沟通过程中，判断会话是否已经完成，如果坐席判断会话已经完成，可以通过系统下发提示消息“您的问题是否已经解决，结束请回复1，如2分钟内没有答复，则此次会话结束。
”如果用户回复“1”，则系统自动关闭此次会话，并下发提示文字“此次会话已结束，谢谢您的惠顾！”同时，系统将队列中待服务的一个用户放入坐席服务队列中。
如果用户2分钟内没有答复，即可视为用户离线，坐席可关闭与该用户的对话，系统执行与上面同样的操作。
2.2.2微博客服2.2.2.1申请客服官方微博账号如果有可能利用的微博测试账号，尽量利用已有账号，如果没有则通过华胜或者摩卡的名义申请。
微博账号的名字定为“多媒体服务平台”。
2.2.2.2微博客服首次关注提示语用户关注“多媒体服务平台”官方微博后的，首次进入官方微博界面提供给用户的提示语：“欢迎关注多媒体服务平台官方微博，我们将竭诚为您服务！”2.2.2.3微博客服菜单用户进入多媒体服务平台官方微博客服界面后，下方展示3*5菜单，分别为：“我的账户”-》“我的资料”、“我的账单”、“我的积分”、“我的额度”“产品资讯”-》“最新推荐”、“精彩特惠”、“生活服务”、“抽奖活动”“特色服务”-》“账号绑定”、“人工客服”、“周边网点”、“常见问题”其中，“人工客服”为用户与微信客服坐席直接交流的入口，“账号绑定”提供验证用户身份并绑定用户账号的功能，其他的选项为用户自助服务内容。
2.2.2.4用户身份绑定除用户主动进行“账号绑定”操作外，在未绑定用户的情况下，如果用户进行需要身份信息的操作，例如：查询“我的资料”、“我的账单”、“我的积分”、“我的额度”；以及进入“人工客服”时。
用户身份绑定界面上，有“账号”、“密码”、“验证码”输入框，点击“绑定”按钮，提交后台进行绑定。
后台验证用户身份后，将用户的微博openId与账号绑定起来，后续再使用需要身份信息的服务时，无需再次验证身份。
2.2.2.5用户与客服坐席的在线沟通在完成用户身份绑定的情况下，用户可以与坐席进行在线沟通。
如果用户还未绑定身份，则先弹出上节的界面进行身份绑定。
用户在微信、微博上与坐席在线沟通的界面使用微信、微博文字交互界面即可。
客服人员在沟通过程中，如用户2分钟没有回复，则系统初步判断与用户的会话已经完成，则系统下发提示消息“您的问题是否已经解决，结束请回复1，如2分钟内没有答复，则此次会话结束。
”如果用户回复“1”，则系统自动关闭此次会话，并下发提示文字“此次会话已结束，谢谢您的惠顾！”同时，系统将队列中待服务的一个用户放入坐席服务队列中。
如果用户2分钟内没有答复，即可视为用户离线，坐席可关闭与该用户的对话，系统执行与上面同样的操作。
操作流程图同“2.2.1.5用户与客服坐席的在线沟通”。
2.2.3统一坐席界面2.2.3.1服务队列在页面上有排队中的用户列表，已经正在会话中中用户列表，其中会话中的用户列表，标明未读消息个数。
2.2.3.2会话区会话窗口为当前客服人员正在与之沟通的用户的对话状态，包括已发送对话的展示窗口和输入对话的窗口。
2.2.3.3用户信息界面上有显示用户个人信息的区域，包括主要的个人特征信息，包括：姓名、昵称、性别、地域、手机号码等，试微博、微信接口所能提供的用户属性而定。
2.2.3.4常用词界面上有显示客服常用词的区域。
有分类查询和搜索功能。
2.2.4系统管理2.2.4.1系统配置系统角色管理：系统的角色包括：“管理员”、“坐席班长”、“坐席”、系统预设一名管理员，可以给系统中所有用户配置角色，系统新建用户时，有选择角色的选项，默认为“坐席”。
系统用户管理：可以新建、编辑、停用和删除用户，每个用户的属性包括：“姓名”、“员工Id”、“邮箱地址”、“手机号码”、“角色”、“技能”等。
其中，技能是指该坐席所具备的客服技能，包括：“话务客服”、“微信客服”、“微博客服”等。
2.2.4.2统计报表服务总量：按时间段（选定起止日期）统计的访问系统的互联网用户总量、所属渠道、是否解决用户问题等。
客户来访报表：按时间段（选定起止日期）统计某一渠道来访客户的频率频率，按从使用频率从高到低排序。
坐席管理和监控可以设定每个坐席可同时服务用户的数量。
可以查看当前在线坐席的清单。
可以查看当前每个坐席服务中的用户队列快照，总量和所属渠道。
2.2.4.3系统日志可以按时间段（选定起止日期）查询服务用户的清单，包括用户的主要特征和属性。
可以查询每个用户会话的列表清单。
2.3 系统非功能性需求2.3.1路由分配结合AVAYA的路由分配功能，调用TSAPI接口实现对互联网客服的路由分配。
具体的接口调用方式，需要另行沟通。
互联网客服坐席的路由分配与语音坐席不同，互联网坐席可以同时与多个用户处于会话中，然后分时与每个用户沟通，而语音客服每次只能与一个用户通话。
由于这个差异的存在，需要我们实现CTI路由策略的差异化处理。
2.4 产品目标2.4.1 产品定位作为demo系统，提供售前演示环境，为客户了解我方产品提供直观的感受，并进行技术验证。
2.4.2 产品亮点【内容】说明产品区别于竞争对手的主要特点，该特点需要哪些技术手段的保证或技术关键点的突破才能够得以实现。
【裁剪原则】如果此方面没有特殊要求，允许裁剪掉。
2.5设计约束2.5.1需求约束本系统应当遵循的标准：数据命名的规则遵循《Java语言编程规约》相应规定；软、硬件环境：客户端操作系统：Android，IOS等移动操作系统；客户端硬件设备：Android手机等移动终端；JDK版本1.6以上；Android SDK版本2.2以上、IOS4以上。
接口/协议：系统提供接口服务的通信协议为HTTP协议；并使用微博、微信提供的相应API；用户界面：系统WEB界面，保证一般使用者的无障碍操作。
软件质量：正确性：系统必须保证操作能够被正确处理；健壮性：系统应该能7*24小时无故障运行；效率：系统可以支持复数管理员同时登陆，处理响应时间不超过5秒钟，接口服务支持每秒200并发。
易用性：平台界面便于业务人员操作；安全性：用户数据分别存储，分级用户权限控制；可扩展性：系统基于分模块设计，灵活支持需求二次开发，延展性强；2.5.2隐含约束作为演示用demo系统，应外观简洁美观，操作方便；系统应提供日志查询审记追踪功能；把有可能变动的参数存放到配置文件或数据库中，保证修改参数的灵活性。
第3章系统设计策略3.1 基础结构●开发环境：Eclipse；●系统基础架构：Spring+Mybatis；●外部接口：微信API，微博API；3.2 设计策略3.2.1扩展策略系统采用分模块设计开发，便于将来功能的扩展。
并且在系统设计时应采取如下的策略：1.为了保证增加的新功能或者接口变动时程序改动规模最小化，应采用报文格式配置文件解析、组织报文。
2.为了保证系统的灵活性，应该把可变参数保存到配置文件或数据库中。
3.2.2复用策略系统独立模块设计上考虑可复用，即提供给其他模块灵活使用。