概要设计说明书规范
概要设计说明书是概要设计阶段结束时提交的文档。
1. 引言
1.1 编写目的
1. 阐述编写概要设计说明书的目的
2. 说明概要设计的用途
3. 指明该设计所针对的读者对象
1.2 项目背景
1. 概要设计的背景、环境,主要内容和使用范围
2. 本项目的委托单位、开发单位和主管部门
3. 该软件系统与其他系统关系。
1.3 定义
给出本文档中所使用的专门术语的定义及英文缩写的原文
1.4 参考资料
列出相关资料的作者、标题、编号、发表日期、出版单位或资料来源,包括:
1. 经核准的项目计划任务书、合同或上级机关的批文;
2. 项目开发计划
3. 需求规格说明书
4. 测试计划(初稿)
5. 用户操作手册
6. 文档所引用的资料、采用的标准或规范。
2. 任务概述
2.1 目标
描述软件系统要实现的功能。
2.2 运行环境
1. 硬件平台
2. 软件平台
3. 其他软件组件或与其共存的应用程序。
2.3 需求概述
用户对该软件系统的要求:
1. 需求实现的功能
2. 界面要求
3. 可扩充的功能等
2.4 限制描述
阐述本系统概要设计中还没有实现的功能,如文档中没有提出解决的用户需求,
需改进的地方。
3. 总体设计
3.1 基本设计概念和处理流程
描述每个功能模块的定义及其处理流程。
3.2 系统总体结构和模块外部设计
总体结构、系统又哪些模块组成以及个模块之间的关系。
3.3 功能分配
描述系统所需要的功能,并表明各项功能需求与程序结构的关系。
4. 接口设计
4.1 外部接口
描述系统与其他外部组件间的接口关系,包括用户界面、软件接口与硬件接口。
4.2 内部接口
系统中个模块之间的接口、调用关系,以及模块间的数据传输关系。
5. 数据结构设计
5.1 逻辑结构设计
系统中所有抽象数据的逻辑描述。
5.2 物理结构设计
描述系统中相关数据的物理结构。
5.3 数据结构与程序的关系
描述某一数据结构与哪一程序模块关联,既被哪一模块使用。
6. 运行设计
6.1 运行模块的功能
描述系统运行时,模块之间的调用、组合关系。给出在不同运行控制下,
各个模块的组合方式,以及每种运行所经历的内部模块的控制流和数据流。
6.2 运行控制
描述系统运行时,模块之间的调用、控制关系,包括控制范围和作用范围,
说明各种运行方式及其具体操作步骤。
6.3 运行时间
描述系统对整体及单个模块运行时间的要求,以及所要达到的运行时间标准。
7. 出错处理信息
7.1 出错输出信息
描述系统可能出现的错误信息。用表格方式说明各种可能的错误或故障出现时,
系统出现的信息、含义及处理办法。
7.2 出错补救措施
说明错误或故障出现时,可采用的补救措施。如性能降低、恢复及重启等。
7.3 系统恢复设计
描述当系统出现错误或异常时,如何是系统恢复到正常位置。
8. 安全保密设计
为系统的安全和保密而进行的设计,如数据备份、密码管理等。
9. 维护设计
说明为了方便维护工作而采取的措施。