项目总体设计规格说明书规范

项目总体设计规格说明书规范

拟制人 评审人 批准人

日期 日期 日期

保密须知

本文档属公司内部文档，所有权归公司所有，仅限于相关部门之间传阅。任何人未经公司书面许可，不得擅自发送给相关部门以外的第三方阅读，更禁止向杂志、互联网等公开，以及印刷成任何形式出版物公开发行。如果确实需要将本文档递交给相关部门以外的三方阅读，请先咨询您的主管，或者文档的编制者，或者公司法律顾问。

文档更新历史

目录

1

引言 .......................................................................................................................................... 5 1.1 编写目的 ................................................................................................................................... 5 1.2 项目背景 ................................................................................................................................... 5 1.3 定义 .......................................................................................................................................... 5 1.4 参考资料 ................................................................................................................................... 5 2

项目概述 ................................................................................................................................... 5

2.1 工作内容 ................................................................................................................................... 5 2.2 主要参加人员 ........................................................................................................................... 6 2.3 产品 .......................................................................................................................................... 7 2.3.1 2.3.2 3

程序 ................................................................................................................................... 7 文件 ................................................................................................................................... 7

总体设计 ................................................................................................................................... 8

3.1 处理流程 ................................................................................................................................... 8 3.2 总体结构和模块外部设计 ......................................................................................................... 9 3.3 功能分配 ................................................................................................................................... 9 4

接口设计 ................................................................................................................................. 10

4.1 外部接口 ................................................................................................................................. 10 4.2 内部接口 ................................................................................................................................. 10 4.3 用户接口 ................................................................................................................................. 10 5

数据结构设计 .......................................................................................................................... 11

5.1 数据结构需求分析 .................................................................................................................. 11 5.2 数据结构初步关系框架 ........................................................................................................... 11 5.3 逻辑结构设计 ......................................................................................................................... 11 6

运行设计 ................................................................................................................................. 12

6.1 运行模块的组合 ...................................................................................................................... 12 6.2 运行控制 ................................................................................................................................. 12 6.3 运行时间 ................................................................................................................................. 12 7

出错处理设计 .......................................................................................................................... 13

7.1 出错输出信息 ......................................................................................................................... 13 7.2 出错处理对策 ......................................................................................................................... 13

8 9

界面设计 ................................................................................................................................. 14 安全保密设计 .......................................................................................................................... 15

10 维护设计 ................................................................................................................................. 16

1 引言

1.1 编写目的

为明确软件需求、安排项目规划与进度、组织软件开发与测试，撰写此文档。本文档为项目开发的设计人员、开发人员提供参考。

1.2 项目背景

a.项目需求：依据的需求文档、总体概要设计文档 开发单位：项目组 b.该软件系统与其他

1.软件系统名称：XXXXX系统

2.该软件系统与其他系统的关系：该系统基于JAVA、微信JSSDK

1.3 定义

(1)可行性研究：目的不是解决问题，而是确定问题是否值得去解决。它是指上是要进行一次大大压缩简化了的系统分析和设计过程，也就是在较高层次上以较抽象的方式进行的系统分析和设计的过程。

（2）需求分析：需求分析是软件定义时期的最后一个阶段，它的基本任务是准确的回答“系统必须做什么”这个问题。

（3）总体设计：又称概要设计或者初步设计，主要由两个阶段组成，系统设计阶段和结构设计阶段。

（4）详细设计：它的根本目的是确定应该怎样具体的实现所要要求的系统。详细设计的结果基本上决定了最终的程序代码的质量。

（5）通常把编码和测试统称为实现。

1.4 参考资料

GB/T 11457:软件工程术语

GB/T 8566-1995：计算机软件开发规范 GB 8567：计算机软件产品开发文件编写指南

2 项目概述

2.1 工作内容

表格1工作内容

2.2 主要参加人员

表格2主要参与人员和角色

2.3 产品 2.3.1 程序

程序名称：MyQQ 所用的编程语言：C# 主要功能：

（1）支持用户注册，本地保存密码、登陆账号 （2）能正常登陆和隐身登陆，以及退出登陆

（3）支持好友列表，并能正确的自动更新、能显示在线好友，并与不在线好友予以区分。支持好友来消息提示。可以根据自己的需要进行好友分组。

（4）能查找、增加、删除好友.，并显示好友信息

（4）能修改基本的个人信息、支持修改个人在线状态、支持设置隐私权限

（5）能主面板最小化、最大化、隐藏操作、支持多个帐户同时登陆，且互不影响、显示输入消息窗口，能及时显示输入的消息、能显示接收到的好友消息、支持打开多个聊天窗口，且互不影响

2.3.2 文件

表格3输出文件

3 总体设计

可另行编写《总体概要设计说明书》。以下是简要的总体设计模版。

3.1 处理流程

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

图3-1 总体结构和模块外部设计

3.3 功能分配

数据库模块总领整个系统，成绩录入模块负责对其进行建立、增加、插入、删除、修改、合并的操作，各模块之间相互协作，功能完备，结构严谨。

图1功能分配

4 接口设计

4.1 外部接口

软件接口：系统利用Visual C#提供与SQL Server2000连接进行访问数据库的操作。 服务器程序可利用SQL Server2000提供的对数据库备份的操作实现对数据库的备份操作。 在网络软件接口方面，采取一种无差错的传输协议进行连接。

硬件接口：输入：采用键盘鼠标以及Visual C#的标准输入/输出进行输入处理。

输出：采用Visual C#的标准输入/输出或其它输出设备对输出进行处理。在统计打印模块还需要有打印机的参与。

在网络传输部分，在网络硬件部分，为了实现高速传输，将使用高速ATM.

4.2 内部接口

数据库模块的操作由管理员通过密码登陆，然后对数据库进行相应的操作。通过对数据库要进行的不同的操作来决定调用另外的哪个模块。模块间采用函数调用、参数传递、返回值的方式进行信息传递。

4.3 用户接口

在QQ登陆界面，需要用户输入登陆账号和相应的登陆密码。当用户输入不正确时，系统将会自动给出提示，请用户进行重新输入；在申请界面和添加好友，个人信息设置界面均有相应的提示信息和警告信息。

5 数据结构设计

5.1 数据结构需求分析

针对自己所要设计的仿QQ聊天系统的需求，设计如下所示的数据项和数据结构：

用户表：QQ号码、QQ密码、加好友的方式编号、昵称、QQ头像编号、性别、年龄

信息类型表：信息类型编号、信息类型

聊天信息表：聊天信息表记录编号、发送信息者QQ号、收到信息者QQ号、发送信息、信息类型编号、信息状态、发送时间

好友表：表添加记录、发送者的QQ、好友的QQ

5.2 数据结构初步关系框架

User(用户表)( QQ号码、QQ密码、加好友的方式编号、昵称、QQ头像编号、性别、年龄)

MessageType(信息类型表)( 信息类型编号、信息类型)

Messages(聊天信息表)( 聊天信息表记录编号、发送信息者QQ号、收到信息者QQ号、发送信息、信息类型编号、信息状态、发送时间)

Friends(好友表)( 表添加记录、发送者的QQ、好友的QQ)

5.3 逻辑结构设计

关键数据定义结构

6 运行设计

6.1 运行模块的组合

首先进入系统的数据库模块，系统根据用户所要进行的操作判别下一步涉及的模块，从而调用相应的其他模块。

该软件的运行模块组合为程序多窗口的运行环境，各个模块在软件运行过程中能较为友好的交换信息，处理数据。

6.2 运行控制

运行控制将严格按照模块间函数调用关系来实现。在登录模块中，需对运行控制进行正确的判断，选择正确的运行控制路径。

在网络传方面，客户机在发送数据后，将等待服务器的确认收到信号，收到后，再次等待服务器发送回答数据，然后对数据进行确认。服务器在接到数据后发送确认信号，在对数据处理、访问数据库后，将返回信息送回客户机，并等待确认。

软件运行时有较为友好的界面，基本上能够实现用户的数据处理要求。

6.3 运行时间

在需求分析中，对运行时间的要求为操作的反应时间必须在用户可以接受的范围内。网络硬件对运行时间有最大的影响，当网络负载量大时，对操作反应将受到很大的影响。所以将采用高速ATM 网络，实现客户机与服务器之间的连接，以减少网络传输上的开销。其次是服务器的性能，这将影响对数据库访问时间即操作时间的长短，影响加大客户机操作的等待时间，所以必须使用高性能的服务器，建议使用 Pentium 4 处理器。硬件对本系统的速度影响将会大于软件的影响。在输入方面，对于键盘、鼠标的输入，可用VISUAL C# 的标准输入/输出，对输入进行处理。

在输出方面，打印机的连接及使用，也可用VISUAL C#的标准输入/输出对其进行处理。在网络传输部分，在网络硬件部分，为了实现高速传输，将使用高速ATM。

系统的运行时间基本可以达到用户所提出的要求。

7 出错处理设计

7.1 出错输出信息

表格4异常信息

7.2 出错处理对策

（1）（初步预测）使用恢复及再启动技术：说明将使用的恢复再启动技术，使软件从故障点恢复执行或使软件从头开始重新运行的方法。

（2）服务器失效： 使用事务处理，出错时，管理员可以通过直接操作数据库，恢复数据

（3）周期性的把磁盘信息记录到磁带上去就是对于磁盘媒体

8 界面设计

可参考UI设计文档。

9 安全保密设计

本系统的进入需要有正确的用户名和密码，限制了数据的使用权限，并进行层层控制，以提高系统的安全保密性。

10 维护设计

维护方面主要为对服务器上的数据库数据进行维护，可使用SQL server 的数据库维护功能机制。定期为数据库进行备份；维护管理数据库死锁问题和维护数据库内数据的一致性。