《概要设计说明书》
1.导言(Introduction)
本章对该文档的目的、功能范围、术语、相关文档、参考资料、版本更新进行说明。
1.1 目的(Purpose)
本文档的目旨在推动软件工程的规范化,使设计人员遵循统一的概要设计书写规范,节省制作文档的时间,降低系统实现的风险,做到系统设计资料的规范性与全面性,以利于系统的实现、测试、维护、版本升级等。
1.2 范围(Scope)
本文档用于软件设计阶段的概要设计,它的上游(依据的基线)是《需求分析规格书》,它的下游是《详细设计说明书》,并为《详细设计说明书》提供测试的依据。
软件概要设计的范围是:软件系统总体结构设计、全局数据库和数据结构设计、外部接口设计、主要部件功能分配设计、部件之间的接口设计等方面的内容。该范围应覆盖《需求规格说明书》中的功能点列表、性能点列表、接口列表。
1.3 命名规则(Naming Rule)
变量对象命名规则:申明全局变量、局部变量对象的命名规则。 数据库对象命名规则:申明数据库表名、字段名、索引名、视图名等对象的命名规则。
1.4 术语定义(Terms Glossary)
术语定义或解释一般用表格形式给出,如表9-1所示。 表9-1 术语定义或解释表
序 术 语 术 语 定 义 号 名 称 软件系统的总体逻辑结构。按照不同的设计方法,有不同的总体逻辑结构。若采用面向功能软件或面向数据的设计方法,总体逻辑结构为一树1 架构 形的功能模块结构图。若采用面向对象或面向部件(构件)的设计方法,总体逻辑结构为部件(构件)的组装图 本软件系统与其他软件系统之间的接口,接口外部设施可以是中间件。接口描述包括:传输方式、2 接口 带宽、数据结构、传输频率、传输量、传输协议 3 数据数据结构包括:数据库表的结构、其他数据结4 5 结构 概念数据 模型CDM 物理数据 模型PDM 视图 角色 子系统 模块 内部接口 相关文件 参考资料 构等 关系数据库的逻辑设计模型,叫做概念数据模型。主要内容包括一张逻辑E-R图及其相应的数据字典 关系数据库的物理设计模型,叫做物理数据模型。主要内容包括一张物理表关系图及其相应的数据字典 在基表或其他视图之上建立的一张虚表,叫做视图,它具有物理表的许多性质,在数据处理和授权上很有用 数据库中享有某些特权操作的用户,叫做角色。角色的权利通过授权来实现 具有相对独立功能的小系统叫做子系统。一个大的软件系统可以划分为多个子系统,每个子系统可由多个模块或多个部件组成 具有功能独立、能被调用的信息单元叫做模块。模块是结构化设计中的概念 软件系统内部各子系统之间、各部件之间、各模板之间的接口,叫做内部接口。接口描述包括:调用方式、入口信息、出口信息等 相关文件是指当本文件内容变更后,可能引起变更的其他文件。如需求分析报告、详细设计说明书、测试计划、用户手册 参考资料是指本文件书写时用到的其他资料。如各种有关规范、模板、标准、准则 6 7 8 9 10 11 12 1.5 参考资料(References) [1] 用户需求报告 [2] 软件开发合同 [3] 数据库设计规范 [4] 命名规范
1.6 相关文档(Related Documents) [1] 《详细设计说明书》 [2] 源程序清单 [3] 测试计划及报告 [4] 《用户使用手册》
1.7 版本更新记录(Version Updated Record)
2.软件架构设计(Software Architecture Design) 2.1 总体结构设计(Design of Collective Structure)
软件系统的总体逻辑结构,按照不同的设计方法,有不同的总体逻辑结构。本指南以结构化设计方法为主,画出系统总体结构图,列出系统的功能模块清单编号、名称、功能,并尽可能描绘出功能模块之间的关系。若用面向对象的Rose工具进行分析和设计,则遵照Rose的要求进行。
总体结构示意图,如图9-1所示。
图9-1 总体结构示意图
2.2 运行环境设计(Design of Running Environment) 该软件系统的运行环境: 硬件平台:
(1)服务器的最低配置要求 (2)工作站的最低配置要求 (3)外设的要求 软件平台:
(1)服务器操作系统 (2)数据库管理系统 (3)中间件
(4)客户端的操作系统 (5)客户端的平台软件 网络平台: (1)通信协议 (2)通信带宽
2.3 子系统清单(Subsystem List) 子系统清单,如表9-3所示。 表9-3 子系统清单
子系统编号 学生信息表 教师信子系统英文名 Student Teacher 子系统功能简述 存储学生信息 存教师信息 子系统之间的关系 显示学生信息数据 显示教师信息息表 班级管理表 考卷管理表 成绩管理表 问题管理表 Class Exampaper Grade Problem 存班级管理信息 存考卷信息 存储考生考试结果信息 存储试卷题目内容 数据 显示班级信息数据 显示考卷信息 显示考生考试结果信息 显示题目内容
2.4 功能模块清单(Function Module List) 功能模块清单,如表9-4所示。 表9-4 功能模块清单
模 块 编 号 1 模块英文名 登入,注册 模块功能简述 模块的接口简述 用于考生、管理身份验证 员、教师登陆管理个人信息 试卷批改、个人教师登陆 信息修改 登陆考试、个人学生登陆 信息修改 管理员修改班班级管理 级信息 创建考卷对考考卷管理 卷的增删改 创建题目,对考题库管理 卷编辑,相当于题库 成绩查询 成绩管理 2 3 4 5 6 教师管理 学生管理 班级管理 考卷管理 问题管理 7 成绩管理
1、学生个人信息查询
学生请求查看个人的信息,系统根据学生登录时的信息,再学生信息表中找到符合条件的信息反馈给学生。查看学生个人信息时序图1-4所示;