软件文档写作第七章.ppt

2.3 概要设计书的写作规范 2.3.1 概要设计书的编制目标 2.3.2 概要设计书的基本要求 2.3.3 概要设计书的内容 2.3.4 概要设计书的编写 2.3.1 概要设计书的编制目标 概要设计的基本任务： 1、设计软件系统结构（简称软件结构） 2、数据结构及数据库设计 3、编写概要设计文档 4、评审 2.3.1 概要设计书的编制目标 概要设计书应该达到以下4个目标： 1、确定开发方案 2、刻画软件的全貌 3、实现客户到软件开发者的转移 4、为详细设计阶段提供可加工的素材 2.3.2 概要设计书的基本要求 从以下4个方面把握概要设计的基本要求: 1、宏观 2、全面 3、逻辑清晰 4、严谨 2.3.3 概要设计书的内容 体系结构、接口设计、出错处理设计、确定开发环境等这类影响整个软件系统主体结构、性能等大方向的问题，必须在概要设计阶段设计完成。 概要设计书中应该包含系统的界面，这些原型界面，简单明了的展现了系统的功能和风格，各子系统之间的关系，也成为了未来实现界面设计的布局标准。 在概要设计阶段还需要制定规范，包括代码体系、接口规约、命名规则。 2.3.4 概要设计书的编写 《概要设计说明书GB8567-88》 1.引言 2.总体设计 3.接口设计 4.运行设计 5.系统数据结构设计 6.系统出错处理设计 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.1.1 编写目的 《研究生教务管理系统》概要设计书是在需求分析书的基础上编写出来的，主要面向系统分析员和程序员。 系统分析员根据需求分析书和概要设计书对软件进行详细设计，同时，概要设计书也是系统分析员向程序员分配代码设计任务的依据。 7.1.2 背景 软件学院学生分布广，有脱产、在职的；学年灵活，2.5-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 需求规定 参见《研究生教务管理系统》软件需求分析书 7.2.2 运行环境 服务器：windows 2000 server 客户端：Internet Explore 6.0 应用服务器：Tomcat5.5 数据库：MySQL 7.2.3 基本设计概念和处理流程 主要功能结构图 7.2.3 基本设计概念和处理流程 学生子系统概要设计 7.2.3 基本设计概念和处理流程 在基本设计概念和处理流程中，说明本系统的基本设计概念和处理流程，尽量使用图表的形式，这是描述软件系统如何实现客户需求的关键部分。 概要设计的工作内容就是确定软件系统的整体框架、处理流程，完成数据库设计，概要设计书就是概要设计阶段的最终产物，其核心部分就是对系统中每个功能的概要设计方案。 功能结构图出现在设计部分的最开始，对整个软件系统提供的功能进行总体描述，指明本系统包含的所有功能模块以及各模块之间的层次逻辑关系。 7.2.3 基本设计概念和处理流程 流程图在概要设计中具有很重要的作用，是表示业务流程的最直观、最准确的方法。一个完整的流程应当包括开始、过程和结束。 绘制流程图应当遵循规范，如方框代表一个处理步骤，菱形框代表一个逻辑判断条件，箭头表示一个控制流等等。详细标准可参阅GB1526－79信息处理流程图图形符号。 流程图从业务流程的角度展现了系统的功能，还需要对功能模块的其他方面进行设计，比如采用MVC框架的应用程序还应该分别对界面、控制和实体进行设计。 7.2.4 结构 学生子系统 No 模块名称 功能需求 程序ID 1 个人信息管理 创建个人基本信息 StudentManage_* 修改个人基本信息 查看个人基本信息