【软件工程】机房文档--概要设计说明书

概要设计说明书

1引言

1.1编写目的

根据软件需求说明,建立目标系统的总体结构和模块间的联系;定义数据库和数据结构;定义目标系统的外部接口包括用户界面;设计系统的安全机制和出错处理机制;定义系统运行,制定组装测试计划,编写文档,概要设计审查和复查。

预期读者:项目设计和编码人员

写这份概要设计是为了对开发此系统做一个大概的设计说明,希望领导给予不同意见的指导,也为了开发出一个更好、更能方便大家使用的新系统出来。

 

1.2背景

说明:

a.      待开发的软件系统的名称:机房收费系统

b.      本项目的任务提出者:米教授

c.      本项目的开发者:白靖

d.      用户和运行该程序系统的的计算中心:廊坊师范学院数信学院计算机中心。

1.3定义

姓名(Name)、卡号(CardNumber)、班级(Class)、教师(Teachers)、上机(Online)、下机(Outline)、时间(Time)、余额(Balance)、退卡(Back of the card)、充值(Recharge)、结账(Checkout

1.4参考资料

a.    《软件工程导论》 张海藩 编著 

b.    邱慕夏《机房收费系统v2.0

c.    《学生信息管理系统》

d.   概要设计说明书(GB8567——88

2总体设计

2.1需求规定

本项目是为了方便教师、学生而设计的,学生可直接输入用户名、密码,即可登录到系统中,查看自己的卡内余额,上机信息,充值信息等。值班教师通过用户名和密码登录系统,给学生注册、充值、退卡,还可以查看学生的上机信息,监督学生刷卡上机、下机等工作。管理员可通过用户名和密码登录系统,进行结账工作及查看教师的值班情况。系统设有三种权限,会根据登录时的级别认证,进入不同的界面。

2.2运行环境

运行环境:win7及以上

SQL sever 2008及以上版本

2.3基本设计概念和处理流程

2.4结构

2.5功能器求与程序的关系

各项功能需求的实现同各块程序的分配关系:

2.6人工处理过程

刷卡上机的工作、必要的确认工作都需要人工来完成,这个系统是一个人机交互的,所以少不了人来操作一些事情

2.7尚未解决的问题

实现像网吧一样的全自动管理,目前只能算是半自动管理。

3接口设计

3.1用户接口

在用户界面部分,用户需要一个友善的界面,在界面设计上需要简单明了,易于操作,而且要注意到届满布局,在设计上采用下拉式菜单。

总的来说,系统界面应该做到可靠,简单,易学。

3.2外部接口

与硬件之间的接口:刷卡机,打印机,键盘,鼠标,网线接口;

与软件之间的接口:SQL server 数据库、报表 excel

3.3内部接口

本系统作为客户端需要通过配置数据源与服务器之间建立连接。

4运行设计

4.1运行模块组合

A.一般用户:主要是查看学生余额、学生上机记录、学生充值记录、学生上机状态查询、修改密码等模块,都涉及到数据库的调用

B.操作员:学生上机情况查询、余额退还查询、注册、充值、退卡、收取金额的模块

C.管理员:主要基本数据设定、添加删除用户、值班教师情况查询、结账、日结账单和周结账单。

4.2运行控制

该系统的主要输入设备是键盘和刷卡器,输出主要是显示器输出和打印机输出。

4.3运行时间

响应时间:0.5s

更新处理时间:0.5s

数据的更换和传送时间:1s内。

5系统数据结构设计

5.1逻辑结构设计要点

机房收费系统共建立了11个表,具体如下:

1)基本数据设定(BasicData_Info

描述

字段名

数据类型

固定用户递增率

Rate

numeric(19,4)

临时用户递增率

tmpRate

numeric(19,4)

递增单位时间

unitTime

int

至少上机时间

leastTime

int

准备时间

PrepareTime

int

最少余额

limitCash

Numeric(19,4)

设定人员

Head

Char(11)

日期

Date

date

时间

Time

time(0)

2)退卡信息(CancelCard_Info

描述

字段名

数据类型

长度

学号

StudentNo

Char

10

卡号

CardNo

Char

10

退卡金额

CancelCash

numeric

(18,1)

日期

Date

Char

10

时间

Time

Char

10

用户名

UserID

Char

10

状态

Status

Char

10

3)日结账单(CheckDay_Info

描述

字段名

数据类型

长度

余额

RemainCash

numeric

(18,0)

充值金额

RechargeCash

numeric

(18,0)

消费金额

ConsumeCash

numeric

(18,0)

退卡金额

CancelCash

numeric

(18,0)

所有金额

AllCash

numeric

(18,0)

日期

Date

Char

10

时间

Time

Char

10

4)周结账单(CheckWeek_Info

描述

字段名

数据类型

长度

余额

RemainCash

numeric

(18,0)

充值金额

RechargeCash

numeric

(18,0)

消费金额

ConsumeCash

numeric

(18,0)

退卡金额

CancelCash

numeric

(18,0)

所有金额

AllCash

numeric

(18,0)

日期

Date

Char

10

时间

Time

Char

10

5)上机信息(Online_Info

描述

字段名

数据类型

长度

卡号

CardNo

Char

10

卡的类型

CardType

Char

10

学号

StudentNo

Char

10

学生姓名

StudentName

Char

10

系别

Department

Char

10

性别

Sex

Char

10

上机日期

OnDate

Char

10

上机时间

OnTime

Char

10

电脑

Computer

Char

10

6)充值记录(Recharge_Info

描述

字段名

数据类型

长度

学号

StudentNo

Char

10

卡号

CardNo

Char

10

充值金额

AddMoney

Numeric

10

日期

Date

Char

(19,4)

时间

Time

Char

10

用户名

UserID

Char

10

状态

Status

Char

10

7)学生信息(Student_Info

描述

字段名

数据类型

长度

学号

StudentNo

Char

10

卡号

CardNo

Char

10

学生姓名

StudentName

Char

10

系别

Department

Char

10

性别

Sex

Char

10

年级

Grade

Char

10

班级

Class

Char

10

金额

Cash

Numeric

(10,3)

备注

Explain

Varchar

50

用户名

UserID

Char

10

状态

Status

Char

10

是否结账

IsCheck

Char

10

日期

Date

Char

10

时间

Time

Char

10

8)用户信息(User_Info

描述

字段名

数据类型

长度

账号

UserID

Char

10

密码

PWD

Char

10

级别

Level

Char

8

用户名

UserName

Char

10

9)值班信息(WorkLog_Info

描述

字段名

数据类型

长度

用户名

UserID

Char

10

级别

Level

Char

10

登录日期

LoginDate

Char

10

登录时间

LogoutTime

Char

10

注销日期

LogoutDate

Char

10

注销时间

LogoutTime

Char

10

电脑名

Computer

Char

10

状态

Status

Char

10

10)学生上下机记录(Line_Info

描述

字段名

数据类型

长度

系列

Serial

Numeric

9

卡号

cardNo

Char

10

学号

studentNo

Char

11

姓名

studentName

Char

10

系别

Department

Char

10

性别

Sex

Char

10

上机日期

onDate

Char

10

上机时间

onTime

Char

10

下机日期

offDate

Char

10

下机时间

offTime

Char

10

消耗时间

consumeTime

Char

10

消费金额

Consume

Numeric

9

剩余金额

Cash

Char

10

状态

Status

Char

8

 上机电脑

Computer

Char

10

11)正在值班教师(OnWork_Info

描述

字段名

数据类型

长度

用户名

UserID

Char

10

级别

Level

Char

10

注册日期

Logindate

Char

10

注册时间

loginTime

Char

10

上机电脑

Computer

Char

10







各表间的关系如下:

5.2物理结构设计要点

由客户端输入的信息存入服务端的数据库中,访问方式根据操作人员而定。

5.3数据结构与程序的关系

系统的数据结构由标准数据库语言SQL生成

6系统出错处理设计

6.1出错信息

错误

处理方式

验证用户身份

用户名错误或是密码错误,有提示框弹出,提醒重新输入

卡内余额不足

暂时不能上机,提示先充值

验证卡号

不存在,提示先注册;错误,重新输入

修改信息异常

退出系统,重新登录

6.2补救措施

当操作出现异常时,采用回复再启动技术,使软件从头开始重新运行

6.3系统维护设计

对于更新的文件及时保存和备份,防止数据的对视损坏。

及时清理数据库数据,提高数据库的运行能力

项目名称 软件概要设计说明书 版本:V1.0 文 档 编 号 保 密 等 级 作 者 最后修改日期 审 核 人 最后审批日期 批 准 人 最后批准日期 修订记录 日期 版本 修订说明 修订人 目 录 1 引言 1 1.1 编写目的 1 1.1.1 作用 1 1.1.2 预期读者 1 1.2 编写背景 1 1.2.1 系统名称及版本号 1 1.2.2 任务提出者 1 1.2.3 任务承接者及实施者 1 1.2.4 使用者 1 1.2.5 与其它系统的关系 1 1.3 文档结构 1 1.4 电子文档编写工具 1 1.5 定义说明与符号规定 2 1.6 参考资料 2 2 系统概述 2 2.1 系统目标 2 2.2 设计原则 3 2.3 运行环境 3 2.3.1 硬件平台 3 2.3.2 软件平台 3 2.3.3 网络体系结构 3 2.4 应用软件整体结构概述 3 2.5 关键技术 4 3 数据库设计 4 4 代码设计 4 5 功能概述 4 5.1 功能模块命名原则 4 5.2 功能层次图 4 5.3 功能简介 4 5.4 外部接口 4 6 用户界面设计 4 6.1 基本原则 4 6.2 设计概述 4 7 出错处理 5 7.1 出错信息设计 5 7.2 异常情况处理 5 引言 编写目的 作用 【说明】《软件概要设计说明书》是在《软件需求规格说明书》的基础上,通过我方与用户方反复沟通形成的。它必须充分反映《软件需求规格说明书》中的用户需求,如有改动必须征得用户的认可。它将作为项目验收时重要的的标准和依据。 从另一方面讲,它又是开发人员在下一阶段进行系统详细设计的纲领性文件,也是考核系统总体质量的重要技术文档预期读者 【说明】本文档的阅读对象是软件开发人员、业务规范设计人员、软件测试人员、系统安装人员及用户代表。 编写背景 系统名称及版本号 【说明】形如“北京市地方税务局管理信息系统V3.0”。其中,版本号的格式为“XX.XX”,X为阿拉伯数字,左“0”可省略。 任务提出者 【说明】指《工作说明书》中规定的我方领导机构或项目负责人。 任务承接者及实施者 【说明】指承担概要设计的负责人及工作人员名单。 使用者 【说明】适应对象和范围。主要指预期读者,也供有关领导审阅。 与其它系统的关系 【说明】在用户现有的及预期的整个应用系统中,给本系统准确定位。用示意图及相应的文字予以说明。 文档结构 【说明】章节划分原则、内容的取舍、重点的确定等。 电子文档编写工具 【说明】工具名、版本号、操作系统平台。使用多种工具时,应分别说明。形如: Microsoft Word 97 for Windows 95 Power-Designor 6.0 for Windows 95 PhotoShop 4.0 for Windows 95 Visio或Power Point 定义说明与符号规定 【说明】包括对专用术语及缩略语的解释、所用到的图(E-R图/功能层次图)中图符的表示与解释、屏幕界面中图标与按钮的表示与含义等。如在E-R图中,表示两个实体之间的关系时,我们定义了以下图符(部分举例): 终结符 基数(自左至右) 1 多 终结符 基数 存在性 说明(自左至右) 1 强制 必须存在且只能存在1个 多 强制 必须存在1个或多个 1 任选 可能存在1个,或没有 多 任选 可能存在1个或多个,或没有 参考资料 【说明】格式:作者,[版本号,]资料来源,日期 [,起止页号]。其中,《质量保证计划》与《需求规格说明书》是必选的参考资料。 系统概述 系统目标 【说明】开发意图、应用目标(总目标、分期目标)、作用范围、预期效益等。 设计原则 【说明】设计原则应包括: 质量管理应贯穿于整个设计之全过程。 对质量保证的承诺应落实到全体人员。 实际执行的过程中,必须符合项目自身的特点,体现个性差异,切实做到有的放矢。 运行环境 硬件平台 【说明】指出本系统对硬件设备的需求、我们选型的原则和依据、推荐的型号与配置、性能综述、技术优势、特殊约定等。 软件平台 【说明】使用操作系统的名称、生产厂家、版本号等。 使用数据库的名称、生产厂家、版本号等。如使用了多种数据库,则要说明如何 实现互连。 其它支撑软件:指出开发与运行时需要的工具软件的情况,如4GL等。 对于选用的各类软件,均应着重说清其技术特点、与国内外同类产品的比较,明 确阐述我方选择的理由。 网络体系结构 【说明】写明网络设计原则、技术要求、产品选型、拓扑结构、基本部件与配件、传输介质、接口情况、通信协议、约束条件、结构化综合布线方案等。 画出网络结构图。图中应标出各类服务器与客户机、网管机、路由器、网关等的数量与分布;应反映出局域网、广域网及其互连的情况;如使用国内的公用数据网或Internet,也须具体标出。 用文字说明各个服务器/客户机的作用、配置与具体位置。例如:Oracle数据库服务 器1台,位于局信息中心,用于支撑征管业务信息处理、领导决策辅助支持、各征管业务科室的信息采集、查询及统计工作。它安装在IBM RS6000小型机上,操作系统是AIX 3.2。 说明拟采取的网络保护技术,如防火墙等。 应用软件整体结构概述 【说明】说明本系统的各层模块、公用模块的划分原则。 如果系统复杂而开发者又有比较多的技术积累,应说明其分层构造(如组件层、构件层与应用子系统层)。 对于大的系统,应画出体系结构图并予以说明。 关键技术 【说明】本系统采用了哪些关键技术,如算法、中间件、构件等。 指出使用了那些主要工具。 解释作出上述选择的理由。 说明这些关键技术在整体结构中的位置及内外接口。 数据库设计 【说明】单独成册,见《数据库设计说明书模板》 代码设计 【说明】 给出系统设计中的代码的设计内容,代码设计包括系统代码(硬码)、系统代码(软码)、业务代码以及标准化代码等。对于硬码的引用需要在数据库设计的PDM中注明,对于其他代码的引用需要在数据字典或数据库设计中注明。 功能概述 功能模块命名原则 【说明】指出本系统的各层模块/公用模块的划分原则、命名原则、编号原则。并且需要指出在概要设计中的功能模块编号与《软件需求规格说明书》中的业务需求编号及性能需求编号之间的对应关系。 功能层次图 【说明】指明在输入信息转变为输出信息的过程中,为了满足用户的业务需求,应用软件必须完成的基本动作。采用自然语言叙述+树状功能图描绘的方式。由此确定系统最终的菜单结构。 功能简介 【说明】用一览表或框图的形式扼要说明每个模块的编号、名称和基本功能。用矩阵形式标明《软件需求规格说明书》中列出的各项功能需求与模块之间的对应关系。 外部接口 用户界面设计 基本原则 【说明】指出基本风格、屏幕总体布局和输入/输出的常规手段。 设计概述 【说明】本节的内容也可以归入附录“设计与编程规范、惯例及约定”中,而不在这里 叙述。 一般地讲,界面设计应包括以下几项: □屏幕环境设置 □字型与字体 □颜色 □提示 □菜单(Menu) □按钮(Command Button) □图标 □列表框 □常用键 □Data Windows生成标准 □窗口定义 □日期类型 (特别要注意解决“千年虫”问题) □界面语言 □其它 出错处理 出错信息设计 【说明】扑捉出错信息、分析定位、提示信息。 异常情况处理 【说明】错误处理方案与帮助手段。
评论 36
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值