概要设计说明书(模板)

第*页（共*页）项目组名称系统软件概要设计说明书编写：日期：审核：日期：批准：日期：受控状态：是发布版次：1.0日期：版本变更记录日期版本变更说明作者YYYY-MM-DD1.0初始版本目录TOC\o"1-3"\h\z1 引言 41.1 编写目的 41.2 背景 41.3 定义 51.4 参考资料 52 总体设计 52.1 需求规定 52.2 运行环境 72.3 基本设计概念和处理流程 72.3.1 系统建设的原则 72.3.2 基本设计概念 82.3.3 基本处理流程 82.4 系统结构设计 92.4.1 系统模块结构 92.4.2 类分析与设计 92.4.3 类图 112.5 功能需求与程序的关系 113 用户接口设计 124 系统数据结构设计 13引言编写目的说明编写这份概要设计说明书的目的，指出预期的读者。以下为示例：概要设计说明书建立在前期的需求分析基础之上，目的在于明确说明模拟股票交易系统的客户端与服务端后台的基本框架，登录，股票交易，买卖，显示，查询等几个模块的数据流程图，了解系统中数据的基本流向，以更好地计划、指导、规范开发过程。它是为了说明整个系统的体系架构，以及需求用例的各个功能点在架构中的体现，为系统的详细设计人员进行详细设计时的输入参考文档。预期读者为：系统设计人员及开发人员。背景以下为示例：当下购买股票是现代人一种非常风靡的理财、投资的方式，而模拟股票交易系统的存在也尤为重要。任何一种理财、投资工具都具有其不同的风险及回报，回报越高，风险也越大。股票投资相比于银行储蓄及债券购买，它的风险最高，但若能掌握好，也能给人们带来非常高的经济收益。然而目前的上市公司已有上千家，每日产生的信息量更是难以估计，若没有现金的电脑软件佐以辅助，是很难了解市场的运作情况并做出判断。可以说，买股票不使用相应的分析软件无异于“盲人骑瞎马”，想要稳住收益又不被套住是很困难的，具有很大的不确定性。故而，“工欲善其事，必先利其器”，买股票也是如此。因此模拟股票交易系统的存在意义也显得尤为重要。本系统可以帮助用户进行模拟的股票交易训练，方便初学者熟悉和掌握股票交易的流程和操作细节，让投资者们更加熟练的掌握股票交易的规则和玩法，便于日后实盘操作。定义说明文档中使用的术语与缩略语，若没有相关说明，则写“无”。以下为示例：（1）C/S：客户端/服务器端结构，是软件系统体系结构，通过它可以充分利用两端硬件环境的优势，将任务合理分配到Client端和Server端来实现，降低了系统的通讯开销。参考资料列出本文档涉及或可能使用到的参考资料，如：本项目的经核准的计划任务书和合同、上级机关的批文。属于本项目的其他已发表的文件；本文件中各处引用的文件、资料，包括所要用到的软件开发标准。列出这些文件资料的标题、文件编号、发表日期和出版单位，说明能够得到这些文件资料的来源。以下为示例：（1）软件工程开发报告模板标准：概要设计说明书（GB8567——88）（2）软件需求说明书（V1.0）总体设计需求规定以下只列出部分示例，需自行补充完整。说明对本系统的主要的输入输出项目、处理的功能性能要求。以下为示例：本系统主要完成的功能有：股票信息查询、用户信息管理、资金管理、股票交易、交易信息管理、用户管理、资金审批功能。股票信息查询功能：针对游客和用户，开放股票信息查询功能，股票用户、普通用户可以通过本系统实现查看指定股票市场的相关股票信息，如当前价格、开盘价格、市盈率。用户信息管理功能：该功能包括：用户的登录、注册、个人信息修改功能。股票用户可以通过本系统进行用户的登录、注册、个人信息修改。资金管理功能：资金管理用例的功能又可细分为：转入资金功能、转出资金功能。转入资金功能：根据用户需求可以申请向自己的账户里面转入资金以便于购买股票。转出资金功能：根据用户需求可以申请由自己的账户里面转出部分或全部资金到用户的银行账户上去。股票交易功能：股票交易用例又可细分为：购买功能、出售功能、撤单功能。购买功能：股票用户登录系统后，可以在任意时刻买进某股市的股票。出售功能：股票用户可以在任何时间出售自己有的股票，以赚取利益。撤单功能：股票用户在购买或卖出股票的交易中由于突发原因需要停止交易可提出撤单。交易信息管理功能：交易历史管理用例的功能又可细分为：查看历史成交功能、查看委托追踪功能。查看历史成交功能：用户可登陆系统查看自己的股票交易明细。查看委托追踪：用户查看未成交的委托单信息追踪。用户管理功能：用户管理用例的功能又可细分为：登陆功能、注册功能、个人信息修改功能。登陆功能:股票用户通过登录进入股票操作的主界面。注册功能:游客可以用过系统注册功能来注册用户，以能够进行股票交易。个人信息修改功能:股票用户可以通过主界面的修改个人信息功能来修改自己的个人信息。资金审批功能：又可细分为：转入资金功能、转出资金功能。转入资金功能：根据用户需求可以申请向自己的账户里面转入资金以便于购买股票。转出资金功能：根据用户需求可以申请由自己的账户里面转出部分或全部资金到用户的银行账户上去。本系统对于输入输出数据的要求如下：表2-1用户登录用例的输入输出数据要求编号数据项数据类型输入/输出范围例子1用户名字符串输入1-12个字符“jack”2密码字符串输入1-12个字符“123”3数量int输入0~232123运行环境以下为示例：处理器：酷睿I3及以上系列的处理器，主频为1.5Ghz以上运行内存：1GMB以上硬盘空间：10G或更多编译系统：JDK1.6及以上操作系统：WindowsXP基本设计概念和处理流程说明本系统的基本设计概念和处理流程，尽量使用图表的形式。以下为部分示例：系统建设的原则作为股票交易系统旨在为股民用户提供最即时的股票信息，方便用户随时随地查阅股票的相关信息。另外，此软件的最终用户为广大股民，他们的教育水平和技术专长残参差不齐，因此，该软件的设计在保证实现网上信息发布基本功能的同时，还要注重对软件的操作要尽量简单，容易上手。基本设计概念在本系统的设计过程中要用的很多技术，列举如下：数据库管理：中心数据库负责存储和备份重要的股票和用户信息，所以合理的管理和维护非常重要。服务器建立：本系统建立在C/S体系结构上，所以必须为用户提供一个服务器，以便用户访问并查询相关股票信息。基本处理流程根据文档《软件需求说明书》中图3-1设备管理系统顶层用例图，该系统的主要用例描述如下：1．用户管理用例（1）用户注册子用例该子用例描述未注册用户若想进行股票交易，必须先注册后登录系统才可进行操作。未注册用户进行注册，先填写用户名、密码进行注册，点击注册按钮，跳出相应界面进行个人详细信息的填写。若注册成功，把用户相关信息写入数据库，用户即可进行相关操作。该场景涉及到的人员的信息包含用户名、密码、手机号、邮箱和所在地等。未注册用户通过填写用户名、密码、确认密码、手机号、邮箱和所在地等信息来成功注册。（2）用户登录子用例该子用例描述对已注册用户登录系统进行处理，已注册用户输入用户名和密码点击登录按钮进入主界面。该过程客户端将用户填写的信息提交到服务器，服务器通过调用数据库中的信息进行对客户端输入信息的验证。若用户存在，则进入主界面，若用户不存在，则提示用户进行注册操作。该场景涉及到的人员的信息包含用户名，密码和角色。管理员和用户通过输入用户名、密码和角色等信息登录系统。系统结构设计系统模块结构说明系统的模块结构。以下为示例：根据文档《软件需求说明书》中图3-1设备管理系统顶层用例图，模拟股票交易系统的模块结构如图2-1所示，包括：用户管理模块、股票信息查询模块、股票交易模块、资金管理模块和交易历史管理模块。图2-1系统模块结构类分析与设计分析与设计系统中的类。以下为部分示例：根据对象分析的结果，对象“用户”、“管理员”、“股票”和“账户”在名称上没有语义重复，因此它们分别对应一个类，具体描述如下：对象“用户”对应类“User”对象“管理员”对应类“Admin”对象“股票”对应类“Stock”对象“账户”对应类“Account”1．User类（1）属性设计根据上文分析结果，类User只拥有一个对象“用户”，因此该类的属性同对象“用户”的属性一一对应如下：对象“用户”的属性“用户名”对应类User的属性userName，数据类型为String对象“用户”的属性“密码”对应类User的属性password，数据类型为String对象“用户”的属性“姓名”对应类User的属性name，数据类型为String对象“用户”的属性“性别”对应类User的属性gender，数据类型为char对象“用户”的属性“身份证号码”对应类User的属性cardID，数据类型为String对象“用户”的属性“电话号码”对应类User的属性phoneNumber，数据类型为String对象“用户”的属性“电子邮箱”对应类User的属性email，数据类型为String（2）方法设计类User中的构造方法与存取方法设计如下：publicUser(Stringusername,Stringpassword,Stringname,Chargender,StringcardID,StringphoneNumber,Stringemail)：构造方法publicvoidsetUserName(StringnewUserName)：该存取方法接收外来字符串类型的参数newUserName，将该参数的值保存在属userName中publicStringgetUserName()：该存取方法将属性userName中的值以字符串类型返回给调用者User类中其余的存取方法的设计与上述第2项和第3项类似。publicvoidregister()：该方法利用User类的属性userName、pwd、name、gender、id和email实现用户注册功能，注册成功返回注册成功信息，注册失败返回注册失败信息publicvoiduserLogin()：该方法利“User”的属性userName,和pwd实现用户登录功能，登录成功返回登录成功信息，登录失败返回登录失败信息publicvoidmoidifyPWD(SringoldPWD,StringnewPWD)：该方法利用User类的属性password实现用户修改密码功能，修改成功返回修改成功信息，修改失败返回错误信息。类User”中其余属性的修改方法类似修改密码的方法类图将类的分析与设计结果画成类图。以下为部分示例：根据类分析与设计的结果，Person类、User类、Admin类、Stock类和Account类对应的类图分别如下图所示：图2-2类图功能需求与程序的关系用一张矩阵图说明各项功能需求的实现同各块程序的分配关系。以下为示例：根据文档《软件需求说明书》中股票交易模拟系统顶层用例图可以看出，用户登录、用户注册、个人信息修改与管理员登录都属于用户管理模块，这两个用例场景的功能在用户管理管理模块中实现。用户购买股票以及卖出股票都属于股票交易，这两个用例场景的功能在股票交易模块中实现。查询股票信息所持股查询、余额查询与查询历史交易信息都属于查询，这两个用例场景的功能在查询模块中实现。用户转入资金申请/审批以及转出资金申请/审批属于资金管理模块，这两个用例场景的功能在资金管理模块中实现。综上，本系统的可分为用户管理模块、股票信息查询模块、股票交易模块、资金管理模块和交易历史管理模块。表2-2功能需求与模块的关系用户管理模块股票交易模块资金管理模块股票信息查询模块交易历史管理模块用户注册√用户登录√管理员登录√个人信息修改√个人信息查询√密码修改√股票购买√股票出售√申请转入资金√申请转出资金√审核转入资金√审核转出资金√查看持有股信息√查看买卖历史记录√查看历史交易记录√用户接口设计说明将向用户提供的命令和它们的语法结构，以及软件的回答信息，如没有则写“无”。系统数据结构设计给出本系统内所使用的每个数据结构的名称、标识符以及它们之中每个数据项、记录、文卷和系的标识、定义、长度及它们之间的层次的或表格的相互关系。以下为部分示例：表4-1用户表User字段名数据类型长度NOTNUL