软件概要设计说明书—模板

1 引言

1.1 目的
介绍编写本文档的目的，主要内容及读者。
1.2 需求概述
描述所要实现的功能和性能等。
1.3 名词及缩略语
列出文档中所用到的专门术语的定义和缩写词的原文。
1.4 参考资料
可包括：
a. 项目经核准的计划任务书、合同或上级机关的批文；
b. 项目开发计划；
c. 需求规格说明书；
d. 文档所引用的资料、标准和规范。列出这些资料的作者、标题、编号、发表日期、出版单位或资料来源。


                          参考资料清单
序号 名称 作者 编号 发布日期 查阅地点或渠道 出版单位（若不为本公司发布的文献，请填写此列）
1.
2.
3.
4.


2 软件概述
介绍软件的应用场合，开发和运行的背景、设计约束等等。
2.1 系统概况
描述软件的主要功能，以及本模块和子系统在系统中所处的位置和作用。
2.2 运行环境
描述软件运行的软硬件环境。
2.3 设计约束
列出进行本软件开发工作的假定和约束，如所采用的语言、开发工具、开发平台、中间件、数据库、外部接口，以及遵循的编码和测试规范等。
3 总体结构设计
3.1 软件结构 
用框图的形式说明本系统的系统元素（各层模块、子程序、公用程序等）的划分，扼要说明每个系统元素的标识符和功能，分层次地给出各元素之间的控制与被控制关系。
3.2 设计思想
结合上图阐述本系统的基本设计思想和理念。 
3.3 尚未解决的问题 
说明在概要设计过程中尚未解决而设计者认为在系统完成之前必须解决的各个问题。
4 模块设计
在此以列表形式说明各模块的名称、功能、接口、发布形式等信息。
4.1 模块1
详细描述各功能模块的功能、接口及内部实现。
4.1.1 功能描述
可以以图表方式说明本功能区域的内部结构，与其他功能模块的详细数据接口流。
4.1.2 接口描述
消息、函数等
4.1.3 数据结构描述
本功能区域使用的数据结构。
4.1.4 类和对象描述
采用类图和对象图描述。
4.1.5 处理流程
画出模块各项功能的实现流程。
4.1.6 编译和链接说明
对模块的编译和链接提出要求，如静态链接、动态链接，生成obj、lib、DLL、bin、hex等。
4.2 模块2
……


5 运行设计
以列表方式描述系统的任务、线程、进程的设置，包括类型、功能、优先级、管理方法等。
6 功能实现流程
以用例图、顺序图、SDL图等方式，详细描述各项功能的实现流程。
7 系统性能分析
列出系统关键性能指标，并且对影响系统性能的功能点进行分析。 
8 数据库及数据结构设计
8.1 数据库及数据表
描述所使用的数据库系统，及数据库和数据表设计。
8.2 数据结构设计
给出本系统内所使用的每个数据结构的名称、标识符以及它们之中每个数据项、记录、文卷和系的标识、定义、长度及它们之间的层次的或表格的相互关系。
8.3 数据存储设计
给出本系统内所使用的每个数据结构中的每个数据项的存储要求，访问方法、存取单位、存取的物理关系（索引、设备、存储区域）、设计考虑和保密条件。
9 定时器设计
列表描述所有定时器的类型、用途、范围、默认值、启动、停止、扫描、超时处理等。
10 外部接口设计
说明本系统同外界的所有接口的安排包括软件与硬件之间的接口、与各支持软件之间的接口、与网管之间的接口等。
10.1 用户界面设计
参见《UI设计说明书》。
10.2 硬件接口
描述需要访问的硬件接口的类型、控制方式,:如中断、寄存器等。
10.3 软件接口
描述与其他模块及子系统的接口。
11 兼容性设计
列出与前后版本，以及其他模块、系统、子系统间可能存在的兼容性问题，以及对策。
12 系统维护设计
12.1 安装和升级
描述软件安装和使用方面的考虑。
描述软件升级的方式，以及升级时的兼容性和数据迁移方面的考虑。
12.2 系统配置
列出系统各种配置项的内容。
12.3 日常维护
如果有日常维护的需要，给出具体的实现方法。
13 系统测试设计
从代码的静态测试，到运行时的动态测试等方面详细描述实现方法。


14 安全和可靠设计
14.1 系统安全
1. 系统安全控制和物理保护措施
2. 用户身份鉴别机制
3. 用户对系统的访问权限和范围
14.2 数据安全
说明在数据库的设计中，将如何通过区分不同的访问者、不同的访问类型和不同的数据对象，进行分别对待而获得的数据库安全保密的设计考虑，如：
1. 数据用户身份鉴别
2. 访问时的控制策略和实现方法
3. 数据加密方法
14.3 可靠性设计
14.3.1 故障模式及影响分析（FMEA）
列表分析各种可能的故障模式，以及相应的对策。
14.3.2 避错和容错设计
列举所采取的避错和容错设计措施，降低系统故障概率。
14.3.3 冗余设计
如采取系统冗余、 数据冗余等措施。
14.3.4 故障检测和恢复机制
可以采用watchdog、守护进程、异常处理等机制检测系统故障，并且进行局部或全局重启动机制，恢复系统运行。
对于数据的恢复，可以从冗余或备份数据中恢复。
15 日志和错误处理
15.1 日志记录机制
用一览表的方式说明每种可能的日志（如运行日志、操作日志、故障日志）如何进行记录，记录那些内容。
15.2 错误信息及输出机制

用一览表的方式说明每种可能的出错或故障情况出现时，系统输出信息的形式、含义及处理方法。

来源:http://blog.csdn.net/lezhiyong