项目总体设计规格说明书规范标准[详]

1、文档名称密级工程总体设计规格说明书标准机密文档版本共16页V1.0.0工程总体设计规格说明书标准日期日期日期拟制人评审人批准人保密须知本文档属公司内部文档,所有权归公司所有,仅限于相关部门之间传阅.任何人未经公司书面许可,不得擅自发送给相关部门以外的第三方阅读,更禁止向杂志、互联网等公开,以及印刷成任何形式出版物公开发行.如果确实需要将本文档递交给相关部门以外的三方阅读,请先咨询您的主管,或者文档的编制者,或者公司法律参谋.文档更新历史版本修订者修订日期修订内容修订审核目录1 引言51.1 编写目的51.2 工程背景51.3 定义51.4 参考资料52 工程12述52.1 工作内容52.2 主

2、要参加人员62.3 产品72.3.1 程序72.3.2 文件73 总体设计83.1 处理流程83.2 总体结构和模块外部设计93.3 功能分配94 接口设计104.1 外部接口104.2 内部接口104.3 用户接口105 数据结卞设计115.1 数据结构需求分析115.2 数据结构初步关系框架115.3 逻辑结构设计116 运行设计126.1 运行模块的组合126.2 运行限制126.3 运行时间127 出错处理设计137.1 出错输出信息137.2 出错处理对策138 界面设计149 平安保密设计1510 维护设计161引言1.1 编写目的为明确软件需求、安排工程规划与进度、组织软件开发与

3、测试,撰写此文档.本文档为工程开发的设计人员、开发人员提供参考.1.2 工程背景a.工程需求：依据的需求文档、总体概要设计文档开发单位：工程组b.该软件系统与其他1 .软件系统名称：XXXXXK统2 .该软件系统与其他系统的关系：该系统基于JAVA微信JSSDK1.3 定义(1)可行性研究：目的不是解决问题,而是确定问题是否值得去解决.它是指上是要进行一次大大压缩简化了的系统分析和设计过程,也就是在较高层次上以较抽象的方式进行的系统分析和设计的过程.(2)需求分析：需求分析是软件定义时期的最后一个阶段,它的根本任务是准确的答复“系统必须做什么这个问题.(3)总体设计：又称概要设计或者初步设计,

4、主要由两个阶段组成,系统设计阶段和结构设计阶段.(4)详细设计：它的根本目的是确定应该怎样具体的实现所要要求的系统.详细设计的结果根本上决定了最终的程序代码的质量.(5)通常把编码和测试统称为实现.1.4 参考资料GB/T11457:软件工程术语GB/T8566-1995:计算机软件开发标准GB8567:计算机软件产品开发文件编写指南2工程概述2.1 工作内容表格1工作内容可行性研究在较高层次上以较抽象的方式进行系统分析和设计.从技术可行性,经济可行性,操作可行性二方面进行可行性研究.需求分析从功能需求,性能需求,数据需求等方面进行分析.利用DFD,DD,E-R图等,进行需求的获取,分析,定义

5、以及验证.书写需求规格说明书.总体设计/详细设计先进行概要设计,包括系统设计,结构设计利用模块化,抽象,逐步求精,模块独立等设计原理,初步对工程技进行设计.详细设计阶段进行细化开发/单元/几次测试源代码,测试用例,单元测试报告系统测试测试总结报告,用户手册实现验收报告,实施方案,培训方案,软硬件安装部署规划书,应用系统部署说明,系统验收,应用程序包2.2 主要参加人员表格2主要参与人员和角色角色负责人专业技术架构设计系统架构设计系统分析员数据库系统设计测试负责人软件测试文档编写人员软件工程编码人员C蝌序设计数据库开发与维护人员Oracle2.3 产品2.3.1 程序程序名称：MyQQ所用的编程

6、语言：C#主要功能：(1)支持用户注册,本地保存密码、登陆账号(2)能正常登陆和隐身登陆,以及退出登陆(3)支持好友列表,并能正确的自动更新、能显示在线好友,并与不在线好友予以区分.支持好友来消息提示.可以根据自己的需要进行好友分组.(4)能查找、增加、删除好友.,并显示好友信息(4)能修改根本的个人信息、支持修改个人在线状态、支持设置隐私权限(5)能主面板最小化、最大化、隐藏操作、支持多个帐户同时登陆,且互不影响、显示输入消息窗口,能及时显示输入的消息、能显示接收到的好友消息、支持翻开多个聊天窗口,且互不影响2.3.2文件表格3输出文件角色文档产品经理?需求规格说明书?架构师?总体概要设计?

7、技术经理?工程总体设计规格说明书?开发工程师?工程详细设计规格说明书?工程经理?工程开发方案?测试人员?系统测试用例?工程测试报告?质量保证人员(QA人员)各个阶段过程和产品的：?QA检查单?和?QA检查记录?相关的标准和标准3总体设计可另行编写?总体概要设计说明书?.以下是简要的总体设计模版.3.1 处理流程工程名称输入处理输出数据来源权限设置1、WB#用户名和密码身份验证申请成功用户输入用户操作2,、登陆账号用户名和密码身份验证根据用户要进行的操作判定下一步进入的模块3、发送消息消息内容消息处理用户输入用户操作4、添加好友用户名将用户名添加到数据库输出好友添加成功界面治理员输入用户操作5、

8、修改信息用户名将修改后的好友信息保存到数据库中输出好友信息修改成功界面治理员输入治理员操作,用户可以更改好友或自己的信息6、删除好友用户名将好友信息从数据库消除输出好友删除成功界面治理员输入治理员操作3.2 总体结构和模块外部设计图3-1总体结构和模块外部设计3.3 功能分配数据库模块总领整个系统,成绩录入模块负责对其进行建立、增加、插入、删除、修改、合并的操作,各模块之间相互协作,功能完备,结构严谨.图1功能分配4接口设计4.1 外部接口软件接口:系统利用VisualC#提供与SQLServer2000连接进行访问数据库的操作.效劳器程序可利用SQLServer2000提供的对数据库备份的操

9、作实现对数据库的备份操作.在网络软件接口方面,采取一种无过失的传输协议进行连接.硬件接口:输入：采用键盘鼠标以及VisualC#的标准输入/输出进行输入处理.输出：采用VisualC#勺标准输入/输出或其它输出设备对输出进行处理.在统计打印模块还需要有打印机的参与.在网络传输局部,在网络硬件局部,为了实现高速传输,将使用高速ATM.4.2 内部接口数据库模块的操作由治理员通过密码登陆,然后对数据库进行相应的操作.通过对数据库要进行的不同的操作来决定调用另外的哪个模块.模块间采用函数调用、参数传递、返回值的方式进行信息传递.4.3 用户接口在QQ登陆界面,需要用户输入登陆账号和相应的登陆密码.当

10、用户输入不正确时,系统将会自动给出提示,请用户进行重新输入；在申请界面和添加好友,个人信息设置界面均有相应的提示信息和警告信息.5数据结构设计5.1 数据结构需求分析针对自己所要设计的仿QCW天系统的需求,设计如下所示的数据项和数据结构：用户表：QQ号、QQ密码、加好友的方式编号、昵称、QQ头像编号、性别、年龄信息类型表：信息类型编号、信息类型聊天信息表：聊天信息表记录编号、发送信息者QQ、收到信息者QQ、发送信息、信息类型编号、信息状态、发送时间好友表：表添加记录、发送者的QQ好友的QQ5.2 数据结构初步关系框架User用户表QQ号、QQ密码、加好友的方式编号、昵称、QQ头像编号、性别、年

11、龄MessageType信息类型表信息类型编号、信息类型Messages聊天信息表聊天信息表记录编号、发送信息者QQ#、收到信息者QQ#、发送信息、信息类型编号、信息状态、发送时间Friends好友表表添加记录、发送者的QQ好友的QQ5.3 逻辑结构设计关键数据定义结构6运行设计6.1 运行模块的组合首先进入系统的数据库模块,系统根据用户所要进行的操作判别下一步涉及的模块,从而调用相应的其他模块.该软件的运行模块组合为程序多窗口的运行环境,各个模块在软件运行过程中能较为友好的交换信息,处理数据.6.2 运行限制运行限制将严格根据模块间函数调用关系来实现.在登录模块中,需对运行限制进行正确的判断

12、,选择正确的运行限制路径.在网络传方面,客户机在发送数据后,将等待效劳器确实认收到信号,收到后,再次等待效劳器发送答复数据,然后对数据进行确认.效劳器在接到数据后发送确认信号,在对数据处理、访问数据库后,将返回信息送回客户机,并等待确认.软件运行时有较为友好的界面,根本上能够实现用户的数据处理要求.6.3 运行时间在需求分析中,对运行时间的要求为操作的反响时间必须在用户可以接受的范围内.网络硬件对运行时间有最大的影响,当网络负载量大时,对操作反响将受到很大的影响.所以将采用高速ATM网络,实现客户机与效劳器之间的连接,以减少网络传输上的开销.其次是效劳器的性能,这将影响对数据库访问时间即操作时

13、间的长短,影响加大客户机操作的等待时间,所以必须使用高性能的效劳器,建议使用Pentium4处理器.硬件对本系统的速度影响将会大于软件的影响.在输入方面,对于键盘、鼠标的输入,可用VISUALC#的标准输入/输出,对输入进行处理.在输出方面,打印机的连接及使用,也可用VISUALC#勺标准输入/输出对其进行处理.在网络传输局部,在网络硬件局部,为了实现高速传输,将使用高速ATM系统的运行时间根本可以到达用户所提出的要求.7由错处理设计7.1 出错输出信息表格4异常信息错误类型出错模块处理方式1.用户账号不存在数据库模块提示用户,说明错误原因,并重新输入2.用户密码输入错误数据库模块提示用户,说明错误原因,并重新输入3.查询的好友账号不存在数据库模块提示用户,说明错误原因7.2 出错处理对策(1)(初步预测)使用恢复及再启动技术：说明将使用的恢复再启动技术,使软件从故障点恢复执行或使软件从头开始重新运行的方法.(2)效劳器失效：使用事务处理