XXXXX 项目

软件(系统/概要）设计说明书

项目令号：

承担部门：

拟 制： （签字\日期）

E - m a i l / Te l ：

审 核： （签字\日期）

批 准： （签字\日期）
国电南京自动化股份有限公司
 国电南京自动化股份有限公司 xx 项目 软件概要设计

模板修改及发布情况记录
拟制人/ 拟制/修改 主要更改内容
版本号 更改理由
修改人 日期 （写要点即可）
2006-8-29 ～
V0.1 蒋衍君 无
2006-9-20
2006-9-23 ～ 根据咨询公司老师的 根据咨询公司建议修改相关
V0.9 蒋衍君
2006-10-10 建议,试运行版 内容,试用版
根据评审的建议修
V1.0 蒋衍君 2006-10-27 根据评审意见修改,试用版
改,正式发布版
对总体设计分层进行补充说
V1.1 李炳军 2011-7-30 根据差距分析修订
明
格式调整、新增模板使用说
V1.2 朱明 2011-08-10 根据差距分析修订 明、新增技术创新总结、技术
复用总结、设计依据需求跟踪
新增数据结构设计要点、新增
V1.3 朱明 2011-08-15 合并 ISO 模板 GM75
标准化设计要点
V1.4 朱明 2016-11-18 需增 PLM 系统电子签章 新增 PLM 系统电子签章

【模板使用说明】
1， 文档“目录”，在内容填写完成后，根据实际页码，更新目录域，重新生成
2， 模板中蓝色显示的提示文本，用于向书写者提供指导和说明，正式填写时应删除。
3， 本模板内容可根据具体项目作适当增加，若对应章节下没有特殊说明的，写“无”而
不要将该节删除或不填写任何内容。
4， 软件总体设计与概要设计的区分就在于设计对象的层级，子系统、构件、模块级的设计
作为概要设计，子系统如果复杂，也可以做一次子系统级的总体设计。
5， 模板的修改记录在各项目实际文档中删除。

软件系统/概要设计文档修改记录
日期 版本 作者 修改内容

注 1：每次更改归档文件（指纳入配置基线的文件）时，需填写此表。
注 2：文件第一次归档时，“更改理由”、“主要更改内容”栏写“无”。

QGM.B009.E-2016 I
 国电南京自动化股份有限公司 xx 项目 软件概要设计

摘要
<描述文档的主要内容。>

QGM.B009.E-2016 II
 国电南京自动化股份有限公司 xx 项目 软件概要设计

目录
第 1 篇概述...................................................................................................................................2
1.1 范围..........................................................................................................................2
1.2 设计依据...................................................................................................................2
1.3 术语、定义和缩略语...............................................................................................2
1.3.1 术语、定义.........................................................................................................2
1.3.2 缩略语.................................................................................................................2
第 2 篇系统总体设计...................................................................................................................1
2.1 系统体系结构...........................................................................................................1
2.2 体系结构概述...........................................................................................................1
2.3 标准化设计...............................................................................................................1
2.3.1 模块标准化设计.................................................................................................1
2.3.2 接口标准化设计.................................................................................................1
2.3.3 界面格式.............................................................................................................1
2.3.4 编码约定.............................................................................................................1
2.3.5 注释约定.............................................................................................................1
2.4 系统版本规划...........................................................................................................1
2.5 系统处理流程...........................................................................................................2
2.6 子系统说明...............................................................................................................2
2.6.1 子系统 1（名称）..............................................................................................2
2.6.2 子系统 2（名称）..............................................................................................2
2.7 系统数据结构设计...................................................................................................2
2.7.1 逻辑结构设计要点.............................................................................................2
2.7.2 物理结构设计要点.............................................................................................2
2.7.3 数据与子系统关系.............................................................................................2
2.8 开发和运行环境.......................................................................................................2
2.8.1 硬件环境.............................................................................................................2
2.8.2 软件环境.............................................................................................................2
2.8.3 外购件分析.........................................................................................................2
2.9 可靠性设计...............................................................................................................2
2.10 可测试性设计...........................................................................................................3
2.11 安全性设计...............................................................................................................3
2.12 出错处理设计...........................................................................................................3
2.13 设计依据与需求跟踪...............................................................................................3
第 3 篇系统运行说明...................................................................................................................1
3.1 配置说明...................................................................................................................1
3.2 系统应用方式...........................................................................................................1
3.3 代码目录说明...........................................................................................................1
第 4 篇技术方案总结...................................................................................................................1
4.1 关键技术问题说明...................................................................................................1
4.2 技术复用说明...........................................................................................................1
第 5 篇总体进度计划...................................................................................................................1
5.1 项目分解...................................................................................................................1
5.2 完成时间...................................................................................................................1

QGM.B009.E-2016 III
 国电南京自动化股份有限公司 xx 项目 软件概要设计

第 6 篇参考文献...........................................................................................................................1
6.1 参考文献...................................................................................................................1

QGM.B009.E-2016 IV
 国电南京自动化股份有限公司 xx 项目 软件概要设计

第1篇 概述
1.1 范围
本文件规定了 XX（产品型号、规格）XX（产品名称）的软件总体设计、系
统运行配置与应用方式以及使用的关键技术等。
本文件适用于 XX（产品型号、规格）XX（产品名称）的开发研制工作。
1.2 设计依据
<要求：列出设计的依据，如有关的国际标准（例如:ITU－T 的建议）、国
家标准、行业标准、企标和有关的法规及文件。>
1.3 术语、定义和缩略语
1.3.1 术语、定义
<要求：逐项列出本文中用到的难以理解或可能引起混淆的术语及其定义。>
1.3.2 缩略语
本文件应用了以下缩略语：
<要求：逐项列出本文中用到的缩略语及其原文和汉语含义。>

QGM.B009.E-2016 1
 国电南京自动化股份有限公司 xx 项目 软件概要设计

第2篇 系统总体设计
2.1 体系结构概述
<要求：
说明在进行软件总体设计时的基本考虑。说明采用何种设计方法对系统进行
分解。必要时，可将所考虑过的多个总体设计作对比分析。对于从已有系统发展
出来的系统，须说明其对已有系统体系结构的继承；对于参照了其他系统的体
系结构设计的新系统，须说明其对参照系统的体系结构的继承。对于系统中被各
个子系统使用的公用模块，须说明公用模块的实现
注：设计师可根据系统自身特点或复杂程度划分系统。系统可由子系统/模块
直接组成。子系统部分还可根据实际情况进行迭代划分。
2.2 系统体系结构（模块功能分配）
<要求：
用框图形式描述系统的软件总体框架结构，并对此进行详细说明，简述各
子系统或模块之间的关系。
说明：软件系统的体系结构应该分为系统总体→子系统→模块。没有子模块
和分系统的概念。对于较小的软件系统可以没有子系统，直接是系统总体→模块
>
2.3 标准化设计
2.3.1 模块标准化设计
<要求：
1） 说明标准模块查询结果,并说明系统将引用的标准模块和他们在系统中
的应用方式
2） 说明本系统准备将哪些子系统/模块进行标准化，供其它产品/项目使用。
>
2.3.2 接口标准化设计
<要求：
1）说明本系统准备将哪些子系统/模块间接口标准化，以及该接口标准化的
意义（例如可以为本项目后续版本开发制定哪些接口约束提高产品互换性
或者提高其它产品/项目研发质量和效率等）>
2.3.3 界面格式
<要求：说明总体界面的设计格式，以及为达到该格式所作的规定。>
2.3.4 编码约定
<要求：说明整个项目小组成员所遵循的编码约定。]
2.3.5 注释约定
<要求：说明准备在设计实现的注释，如：
a. 加在模块首部的注释；
b. 加在各分枝点处的注释；
c. 对各变量的功能、范围、缺省条件等所加的注释；
d． 对使用的逻辑所加的注释等等。 >

QGM.B009.E-2016 2
 国电南京自动化股份有限公司 xx 项目 软件概要设计

2.4 系统版本规划
<要求：说明本系统生命周期内版本研发规划，包括说明每个子系统的研发
规划和相应版本。 >
2.5 系统处理流程
<要求：用图或文字的方式说明系统关键的处理流程，描述各个处理流程所
涉及的子系统或模块以及他们需要进行的处理>
2.6 子系统说明
2.6.1 子系统 1（名称）
<要求：说明该子系统所实现的功能以及对该子系统在性能、可靠性、可维护
性、可移植性、安全性、运行控制、资源占比以及扩展性方面的要求。简述子系统
的实现方案>
2.6.2 子系统 2（名称）
<要求：说明该子系统所实现的功能以及对该子系统在性能、可靠性、可维护
性、可移植性、安全性、运行控制、资源占比以及扩展性方面的要求。简述子系统
的实现方案>
2.7 系统数据结构设计
2.7.1 逻辑结构设计要点
<要求：给出本系统内所使用的每个数据结构的名称、标识符以及它们之中
每个数据项、记录、文卷和系的标识、定义、长度及它们之间的层次的或表格的相
互关系。>
2.7.2 物理结构设计要点
<要求：给出本系统内所使用的每个数据结构中的每个数据项的存储要求，
访问方法、存取单位、存取的物理关系（索引、设备、存储区域）、设计考虑和保
密条件。>
2.7.3 数据与子系统关系
<要求：说明各个数据结构与访问这些数据结构的子系统形式>

2.8 开发和运行环境
2.8.1 硬件环境
<要求：
1） 说明开发本软件系统所需的硬件环境，如计算机、存储设备、网络设
备等。
2） 说明本软件系统对实际运行硬件环境的最低要求及适用范围。>
2.8.2 软件环境
<要求：
1） 说明开发本软件系统所需的软件环境，如操作系统、数据库系统、程序
设计语言、等。
2） 必要时，说明本软件系统运行在怎样的软件支撑环境下。
3） 必要时，说明本软件系统可支持的其他软件开发。>
2.8.3 外购件分析
<要求：

QGM.B009.E-2016 3
 国电南京自动化股份有限公司 xx 项目 软件概要设计

1） 说明开发本软件系统所需的外购软件，如开发工具、开发组件等。
2） 说明外购件的原因与必要性。
>
2.9 可靠性设计
<要求：
说明本软件系统对于可能发生的异常情况需要采用的软件可靠性设计技术。
比如：
1）硬件发生局部故障时，软件采用何种可靠性设计技术，保证整个系统的
正常工作；
2）用户误操作或非法操作时，软件采用何种可靠性设计技术，防止系统瘫
痪；
3）对于关键程序和数据，采用何种软件可靠性设计技术，提高其可靠程度 。
>
2.10 可测试性设计
<要求：
说明本软件系统进行模块测试、子系统测试、系统测试等测试时，设置测试
点的技术。
1） 说明模块中测试设计原理，测试接口，测试内容和范围。
2） 说明子系统中测试设计原理，测试接口，测试内容和范围。
3） 说明系统中测试设计原理，测试接口，测试内容和范围。>
2.11 安全性设计
<要求：
分析产品可能发生的危险的严重性等级和可能性等级，进行系统危险分析
和防范。如：
1） 为防止盗版和防止非法用户进入系统所采用的加密技术；
2） 对重要数据和信息所采用的加密技术；
3） 系统数据的备份和恢复，以及系统数据一致性的校验等设计。>
2.12 出错处理设计
<要求：将出错输出信息和处理对策设计清楚，可以形成出错设计表>

2.13 设计依据与需求跟踪
<要求：
本章详细列出两部分文档，一部分是本文档的上游文档，另一部分是本文
中需要引用的文档（如“术语/定义/缩略语”等
明确对应系统主要功能和性能指标的需求来源，列出设计文档的每一个末
端章节号对应的需求编号+需求名称>。

需求说明书对应章节 需求编号及名称 总体设计对应章节

例：4.2.1 例：4.2.5

QGM.B009.E-2016 4
 国电南京自动化股份有限公司 xx 项目 软件概要设计

第3篇 系统运行说明
3.1 配置说明
<要求：说明系统具备几种配置或工作方式，每种配置完成功能的区别。>
3.2 系统应用方式
<要求：说明系统在实际应用中能提供哪些应用方式，例如：可应用到哪些
场合和设备中，如何与别的设备配合以满足用户的要求。>
3.3 代码目录说明
编写代码目录树结构规划，例：
|---include
| |---ScheDraw
| | |---Components
| | |---Tools
| | |---Commands
| | |---Graphic
|---src
| |---ScheDraw
| |---ScheMaker
| |---ScheViewer
|---bin
|---lib

QGM.B009.E-2016 5
 国电南京自动化股份有限公司 xx 项目 软件概要设计

第4篇 技术方案总结
4.1 关键技术问题说明
<要求：说明系统在设计和开发过程中，需掌握哪些关键技术（包括关键组
件的获得等），有哪些技术难点和不确定的技术问题，说明对这些关键技术的
解决方案，是否有专利限制，并分析技术上的风险（系统设计、软件质量、项目
进度方面的风险）等。>
4.2 技术复用说明
<要求：
总结技术复用情况，总体设计方案技术借用共享说明，借用原有通用件汇
总。>

QGM.B009.E-2016 6
 国电南京自动化股份有限公司 xx 项目 软件概要设计

第5篇 总体进度计划
5.1 项目分解
<把产品的研制开发分解为若干工作项目，列出完成它们必须的先后工作关
系。>
5.2 完成时间
<规定每一工作项目完成的时间范围及工作项目的资源保证。>

QGM.B009.E-2016 7
 国电南京自动化股份有限公司 xx 项目 软件概要设计

第6篇 参考文献
6.1 参考文献
<要求：列出编写本文件时的参考资料。>

QGM.B009.E-2016 8