研发规范-软件概要设计文档.doc

密级
内部资料
软件概要设计文档(模板)
(Version )
XX科技有限公司
2014年6月
文档信息
文档名称
软件概要设计文档
密级
内部资料
文档编号
发布版本
起草时间
2014-6
定稿时间
当前版本

起草人
姓名
部门
电话
电子邮件
审阅人
签发人
文档修改记录
序号
修改时间
修改人
主要修改
存档版本
1
2
3
4
5
6
7
8
9
10
软件概要设计文档
1. 引言 1
编写目的 1
项目风险 1
预期读者和阅读建议 1
参考资料 1
2. 设计概述 2
限制和约束 2
设计原则和设计要求 2
3. 系统逻辑设计 3
系统组织设计 3
系统结构设计 4
系统特性表 4
系统特性结构图 5
系统接口设计 5
系统接口表 5
系统接口传输协议说明 6
系统完整性设计 6
4. 系统出错处理设计 7
系统出错处理表 7
维护处理过程表 8
5. 技术设计 9
系统开发技术说明表 9
开发技术应用说明 10
6. 数据库设计 10
7. 词汇表 10
8. 进度计划 10
引言
引言是对这份软件系统概要设计报告的概览,是为了帮助阅读者了解这份文档是如何编写的,并且应该如何阅读、理解和解释这份文档。
编写目的
说明这份软件系统概要设计报告是基于哪份软件产品需求规格说明书编写的,开发这个软件产品意义、作用、以及最终要达到的意图。通过这份软件系统概要设计报告详尽说明了该软件产品的软件结构,包括数据库结构和出错处理,从而对该软件产品的结构的描述。
如果这份软件系统概要设计报告只与整个系统的某一部分有关系,那么只定义软件系统概要设计报告中说明的那个部分或子系统。
项目风险
具体说明本软件开发项目的全部风险承担者,以及各自在本阶段所需要承担的主要风险,首要风险承担者包括:
任务提出者;
软件开发者;
产品使用者。
预期读者和阅读建议
列举本软件系统概要设计报告所针对的各种不同的预期读者,例如,可能的读者包括:
用户;
开发人员;
项目经理;
营销人员;
测试人员;
文档编写人员;
等等。
描述文档中,其余部分的内容及其组织结构,并且针对每一类读者提出最适合的文档阅读建议。
参考资料
列举编写软件产品概要设计报告时所用到的参考文献及资料,可能包括:
本项目的合同书;
上级机关有关本项目的批文;
本项目已经批准的计划任务书;
用户界面风格指导;
开发本项目时所要用到的标准;
系统规格需求说明;
使用实例文档;
属于本项目的其它已发表文件;
本软件系统概要设计报告中所引用的文件、资料:
相关软件系统概要设计报告:
等等。
为了方便读者查阅,所有参考资料应该按一定顺排列。如果可能,每份资料都应该给出:
标题名称;
作者或者合同签约者;
文件编号或者版本号;
发表日期或者签约日期;
出版单位或者资料来源。
设计概述
本节描述现有开发条件和需要实现的目标,说明进行概要设计时应该遵循的设计原则和必须采用的设计方法。
限制和约束
简要描述起到限制和约束作用的各种可能存在的条件,例如:
技术条件;
资金状况;
开发环境(包括:工具和平台);
时间限制;
等等。
并且说明在上述条件下,应该实现的系统目标,
设计原则和设计要求
描述对本软件系统进行概要设计的原则,通常可以考虑以下几方面的内容:
命名规则;
模块独立性原则:
边界设计原则;
数据库设计规则;
必须的安全措施;
安全性和保密原则;
系统灵活性要求;
系统易操作性要求;
系统可维护性要求;
等等。
系统逻辑设计
本节内容主要根据软件产品需求规格说明书和软件产品数据字典建立系统的逻辑模型。此种模型暂时与系统的物理因素(例如:计算机、数据库管理系统)无关。它是系统需求与物理实现的中间结构,它的主要结果是建立:系统结构图、系统界面结构图、系统出错处理、以及系统开发技术说明。
说明:如果进行系统设计时尚未编写软件数据字典:应首先参照附录B说明,编写软件数据字典。在完成软件数据字典后,再进行系统设计。
系统组织设计
系统组织设计通过系统组织表描述本系统由哪些子系统(模块)组成,这些子系统与业务职能之间的关系,以及各个子系统的安装地点。系统组织表的格式如下:
子系统编号
英文名称
中文名称
业务职能
安装地点
备注
其中:
子系统编号
给出