软件文档写作教程第七章

7.2.3 基本设计概念和处理流程
❖ 流程图在概要设计中具有很重要的作用，是表示业务流程的 最直观、最准确的方法。一个完整的流程应当包括开始、过 程和结束。
❖ 绘制流程图应当遵循规范，如方框代表一个处理步骤，菱形 框代表一个逻辑判断条件，箭头表示一个控制流等等。详细 标准可参阅GB1526－79信息处理流程图图形符号。
软件文档写作教程
马平
北京航空航天大学软件学院
7. 概要设计书案例分析一
❖ 研究生教务管理系统案例分析
❖ 7.1 引言 ❖ 7.2 总体设计 ❖ 7.3 接口设计 ❖ 7.4 运行设计 ❖ 7.5 系统数据结构设计 ❖ 7.6 系统出错处理设计
7.1 引言
❖ 7.1.1 编写目的 ❖ 7.1.2 背景 ❖ 7.1.3 定义 ❖ 7.1.4 参考资料
❖ 档案复杂，有学校集体户口也有自主负责管理；
❖ 课程设置灵活，根据科技的发展时代的变化，会添加删减一 些课程甚至专业；
❖ 由于这些不确定因素的存在，使得教务工作变得复杂而繁琐。 《研究生教务管理系统》就是为了管理这些变化、减轻教务 工作的负担，为学生提供一个了解学院近况、课程状态，可 以与其他学生交流的平台而创建的。
小结
❖ 概要设计是宏观的，全局的设计，注重软件开发的模块化。 ❖ 一方面秉承面向对象的思想，使得代码重用率提高，实现软
件工业化，降低开发周期，提高开发效率。 ❖ 另一方面，将复杂的软件划分为若干简单的模块，使得多人
合作开发变得更为简单明了有序，能够降低开发难度和风险。 ❖ 概要设计不是“大概”的设计，而是宏观的设计，虽然并不
深入细节，但是要保证这些方案都是确实可行且是最优的。
7.6 系统出错处理设计
❖ 7.6.1 出错信息 ❖ 7.6.2 补救措施 ❖ 7.6.3 系统维护设计
7.6.1 出错信息
❖ 本系统将错误分为两种：业务错误和系统错误。
❖ 业务错误是指用户在本系统的使用过程中，违反业务要求进 行的操作。
❖ 系统错误是指数据库连接断开、系统意外停机等不可避免的 意外事故。
❖ 概要设计的工作内容就是确定软件系统的整体框架、处理流 程，完成数据库设计，概要设计书就是概要设计阶段的最终 产物，其核心部分就是对系统中每个功能的概要设计方案。
❖ 功能结构图出现在设计部分的最开始，对整个软件系统提供 的功能进行总体描述，指明本系统包含的所有功能模块以及 各模块之间的层次逻辑关系。
❖ 流程图从业务流程的角度展现了系统的功能，还需要对功能 模块的其他方面进行设计，比如采用MVC框架的应用程序 还应该分别对界面、控制和实体进行设计。
7.2.4 结构
❖ 学生子系统
No
模块名称
功能需求
程序ID
1
个人信息管理 创建个人基本信息
StudentManage_*
修改个人基本信息
查看个人基本信息
答辩时间
3 ce_org_place CHAR
50 可以
答辩地点
4 ce_org_status NVARCHAR 50
答辩类型
5 ce_org_alive CHAR
10 可以
答辩状态
7.5.2 物理结构设计
❖ 在MySQL上只建立一个物理数据库，命名为《EASystem》
7.5.3 数据结构与程序关系
❖ 无特殊要求
7.4 运行设计
❖ 在运行模块组合部分，说明对系统施加不同的外界运行控制 时所引起的各种不同的运行模块组合，说明每种运行所历经 的内部模块和支持软件。
❖ 在运行控制部分，说明每一种外界的运行控制的方式方法和 操作步骤。
❖ 在运行时间部分，说明每种运行模块组合将占用各种资源的 时间。
7.5 系统数据结构设计
7.2.5 人工处理过程
❖无
7.2.6 尚未解决的问题
❖无
7.3 接口设计
❖ 7.3.1 用户接口 ❖ 7.3.2 外部接口 ❖ 7.3.3 内部接口
7.3.1 用户接口
❖ 1、进入《研究生教务管理系统》主页面，用户输入ID和密 码，只有输入正确才能进入系统。
❖ 2、在做新建和更新类操作时，只有输入合法的内容才能成 功地编辑内容。
❖ 在逻辑结构设计要点中，给出本系统内所使用的每个数据结 构的名称、标识符以及它们之中每个数据项、记录、文卷和 系的标识、定义、长度及它们之间的层次的或表格的相互关 系。
❖ 数据结构是计算机存储、组织数据的方式。通常情况下，精 心选择的数据结构可以带来更高的运行或者存储效率的算法。
❖ 在物理结构设计要点中，给出本系统内所使用的每个数据结 构中的每个数据项的存储要求，访问方法、存取单位、存取 的物理关系、设计考虑和保密条件。
❖ 参见《研究生教务管理系统》软件需求分析书
7.2.2 运行环境
❖ 服务器：windows 2000 server ❖ 客户端：Internet Explore 6.0 ❖ 应用服务器：Tomcat5.5 ❖ 数据库：MySQL
7.2.3 基本设计概念和处理流程
❖ 主要功能结构图
研究生教务管理系统
❖ 在外部接口部分，说明本系统同外界的所有接口的安排包括 软件与硬件之间的接口、本系统与各支持软件之间的接口关 系。
❖ 在内部接口部分，说明本系统之内的各个系统元素之间的接 口的安排。
7.4 运行设计
❖ 7.4.1 运行模块组合 ❖ 7.4.2 运行控制 ❖ 7.4.2 运行时间
7.4.1 运行模块组合
❖
N
o
是否选择成绩 查询功能
❖
Y
e
进入成s绩查
询页面
❖
N
o
是否选择管理 功能
❖
Y
e
进入选s课管
理页面
❖N o
是否选择答辩 管理功能
❖
Y
e
进入答s辩管
理页面
退出登录
7.2.3 基本设计概念和处理流程
❖ 在基本设计概念和处理流程中，说明本系统的基本设计概念 和处理流程，尽量使用图表的形式，这是描述软件系统如何 实现客户需求的关键部分。
❖ 7.5.1 逻辑结构设计 ❖ 7.5.2 物理结构设计 ❖ 7.5.3 数据结构与程序关系
7.5.1 逻辑结构设计
❖ 共设计出7个表： ❖ 1、ce_org_table
No 字段名称
类型
Size NULL 主键 说明
1 ce_org_id INT
4
1 答辩ID
2 ce_org_time DATETIME 8
7.6.2 补救措施
❖ 定期对数据进行备份。采用硬盘做备份设备，使用MySQL 提供的备份功能定期对数据库进行备份。
❖ 一旦系统遭到意外破坏，用该备份文件进行恢复。
7.6.3 系统维护设计
❖ 定期重起服务器。保证服务器每周重新启动一次，重启之后 进行复查。
❖ 服务器优化，包括整理系统空间和性能优化。
7.1.1 编写目的
❖ 《研究生教务管理系统》概要设计书是在需求分析书的基础 上编写出来的，主要面向系统分析员和程序员。
❖ 系统分析员根据需求分析书和概要设计书对软件进行详细设 计，同时，概要设计书也是系统分析员向程序员分配代码设 计任务的依据。
7.1.2 背景
❖ 软件学院学生分布广，有脱产、在职的；学年灵活，2.5-5 年内毕业都可以；
7.3.2 外部接口
❖ 1、服务器端配置如运行环境2.2所述。 ❖ 2、客户端必须安装浏览器，如需要打印，还必须安装打印
机。
7.3.3 内部接口
❖ 采用面向对象设计思想，采用类的继承、多态等方式，提高 代码的复用程度。
接口说明
❖ 在用户接口部分说明将向用户提供的命令和它们的语法结构， 以及软件的回答信息。
❖ 1、《研究生教务管理系统》的所有七个模块在服务器启动 的时候完成所有模块的加载工作，随时等候用户的调用。
❖ 2、不同的用户根据权限的不同调用不用的模块。
7.4.2 运行控制
❖ 1、在页面上，通过鼠标点击触发相应的操作。
❖ 2、在页面上，也可以通过Tab键、回车键等功能键完成某 些特定的功能。
7.4.2 运行时间
2
成绩查询
按照查询条件进行成绩查询 StudentScore_* 打印成绩清单
3
选课管理
已选课程查询 课程选择
StudentCourse_*
4
答辩管理
查看个人答辩信息
StudentReply_*
答辩申请
查看答辩成绩
7.2.4 结构
❖ 在“结构”部分，用一览表及框图的形式说明本系统的系统 元素（各层模块、子程序、公用程序等）的划分，扼要说明 每个系统元素的标识符和功能，分层次地给出各元素之间的 控制与被控制关系。
息 绩 息 息 息 程度 辩 绩
查管管 管 管
查信管
询理理 理 理
询息理
财
管
务
理
子
员
系
子
统
系
统
学
新用
生
增户
财
用信
务
户息
管
管
理
理
7.2.3 基本设计概念和处理流程
❖ 学生子系统概要设计
学生 输入用户名和密码
是否选
择个人信息管理 功能
❖Y e
进入人信s ቤተ መጻሕፍቲ ባይዱ管
理页面
用户名、密码 是否正确
❖
N
o
❖Y 进入学生功能页面es
学
教
教
答
实
生
务
师
辩
习
子
管
子
助
管
系
理
系
手
理
统
子
统
子
子
系
系
系
统
统
统
个成 选 答
学个 所学
实
人绩 课 答
生人 授生
习
信 息 管 理
查 询
管 理
辩 进 度 管 理
信信 课答 息息 程辩 查管 管管 询理 理理
手 续 管 理
学 学 教 教 课 新答 新 答
生 生 务 师 程 增辩 增 辩
信 成 信 信 信 课进 答 成
❖ 1、学生子系统关联表： ce_org_table、ce_table、cou_select_table、stu_table、 usr_table
❖ 2、教师子系统关联表： cou_select_table、cou_table、stu_table、tea_table、 usr_table
7.5 系统数据结构设计
7.1.3 定义
❖无
7.1.4 参考资料
❖ 国家软件工程开发标准 ❖ 《研究生教务管理系统》需求分析书
7.2 总体设计
❖ 7.2.1 需求规定 ❖ 7.2.2 运行环境 ❖ 7.2.3 基本设计概念和处理流程 ❖ 7.2.4 结构 ❖ 7.2.5 人工处理过程 ❖ 7.2.6 尚未解决的问题
7.2.1 需求规定