软件概要设计模板
××××软件概要设计说明书
(仅供内部使用) For internal use only
格式:姓名+空格+工号,
例如:张三 12345
拟制: Prepared by
审核: Reviewed by
审核: Reviewed by
批准: Granted by 日期: Date 日期: Date 日期: Date 日期: Date
yyyy-mm-dd yyyy-mm-dd yyyy-mm-dd yyyy-mm-dd
金禧时代信息技术服务有限公司
Kinthtime Information Technologies Service Co., Ltd.
版权所有 侵权必究 All rights reserved
修订记录Revision record
目 录Table of Contents
1 背景 ..................................................................................................................................... 7 2 总体设计 .............................................................................................................................. 7 2.1 系统描述 ........................................................................................................................ 7 2.1.1 需求规格概述............................................................................................................ 7 2.1.2 运行环境规定............................................................................................................ 7 2.1.3 必须满足的国际/国内/企业标准 ................................................................................. 7 2.2 总体设计说明 ................................................................................................................. 7 2.2.1 基本设计概述............................................................................................................ 7 2.2.2 设计思想................................................................................................................... 7 2.3 系统结构和处理流程 ....................................................................................................... 8 2.3.1 系统结构................................................................................................................... 8 3 接口设计 .............................................................................................................................. 8 3.1 外部接口 ........................................................................................................................ 8 3.1.1 用户接口................................................................................................................... 8 3.1.2 硬件接口................................................................................................................... 8 3.1.3 软件接口................................................................................................................... 8 3.1.4 通讯接口................................................................................................................... 8 3.2 内部接口 ........................................................................................................................ 8 4 属性设计 .............................................................................................................................. 8 4.1 可靠性 ............................................................................................................................ 9 4.2 安全性 ............................................................................................................................ 9 4.3 可移植性 ........................................................................................................................ 9 4.4 可测试性 ........................................................................................................................ 9 5 系统数据结构 ....................................................................................................................... 9 5.1 逻辑结构设计要点 .......................................................................................................... 9 5.2 数据结构与模块的关系 ................................................................................................... 9 6 运行设计 .............................................................................................................................. 9 7 系统出错处理 ....................................................................................................................... 9 8 开发环境 ............................................................................................................................ 10 8.1 硬件环境 ...................................................................................................................... 10 8.2 软件环境 ...................................................................................................................... 10 9 系统调试与测试方法........................................................................................................... 10 9.1 调试方法 ...................................................................................................................... 10 9.2 测试方法 ...................................................................................................................... 10
表目录 List of Tables
表1 XX表 Table 1 XX .................................................................................. 错误!未定义书签。
图目录 List of Figures
图1 XX图 Figure 1 XX ................................................................................. 错误!未定义书签。
预研项目软件概要设计说明书
关键词Key words: 能够体现文档描述内容主要方面的词汇。 摘 要Abstract:
缩略语清单List of abbreviations:
和中文解释。Describe abbreviations in this document, full spelling of the abbreviation
and Chinese explanation should be provided.>
1 背景
应包含以下三个方面的内容:
A. 待开发软件系统名称;
B. 该系统基本概念, 如该系统的类型、从属地位等; C. 开发项目组名称; D. 项目代号。
2
2.1 2.1.1
总体设计
系统描述 需求规格概述
对所开发软件的概要描述, 包括主要的输入/输出、主要功能、性能等。
2.1.2 运行环境规定
对本系统所赖于运行的硬件、软件环境的描述。
2.1.3 必须满足的国际/国内/企业标准
对设计必须满足的国际/国内/企业标准做详细的引用或加以界定, 列出引用的标准名或标准原文以及对设计需要满足的标准的说明,有必要须另外编写《企业标准》文档。
2.2 2.2.1
总体设计说明 基本设计概述
列出在描述、说明总体设计时要用到的一些基本概念,给出其解释说明。
2.2.2 设计思想
说明在进行总体设计时的基本考虑。结合设计限制,说明如何根据这些设计限制综合考虑,而建立起目标系统的总体结构并进行功能划分,如有必要,可将所考虑过的多个总体设计作对比分析, 说明选择当前总体结构的原因。
2.3 2.3.1
系统结构和处理流程 系统结构
用框图形式说明目标系统的模块划分, 扼要说明每个模块的标识符和功能, 分层次地给出各元素之间的控制与被控制关系。
3
3.1 3.1.1
接口设计
外部接口 用户接口
列出系统将向用户提供的操作命令及其功能说明和用法描述, 以及系统的响应信息及其含义。对于用户接口,预研系统可以尽可能简化,只要最必需的命令和参数输入,结果显示,命令响应,出错信息等。
3.1.2 硬件接口
说明本系统的硬件接口的设计安排。
3.1.3 软件接口
说明本系统的软件接口的设计安排。
3.1.4 通讯接口
说明本系统的通讯接口的设计安排。
3.2 内部接口
说明本系统内各功能模块间的接口设计。
4 属性设计
说明系统对以下五个方面的属性所作的特殊设计和考虑。
4.1 4.2 4.3 4.4
可靠性 安全性 可移植性 可测试性
5
5.1
系统数据结构
逻辑结构设计要点
说明系统主要数据的逻辑结构, 包括其定义、存储要求、一致性约束条件等。如果采用非C语
言的数据结构描述,必须 给出特别说明和必要的背景介绍。
5.2 数据结构与模块的关系
可采用矩阵图形式, 并规定以下符号: C 创建 U 更新 R 读出使用
6 运行设计
说明对系统运行时的顺序、控制、时间等的设计安排。
7 系统出错处理
8
8.1
开发环境
硬件环境
列出开发本系统所需要的硬件平台、工具等。
8.2 软件环境
列出开发本系统所需要的软件平台(操作系统、数据库、网络平台、相关软件配套版本等)、
软件辅助工具及使用周期。
9
9.1
系统调试与测试方法
调试方法
说明系统调试的环境、工具,应观察的结果等。
9.2 测试方法
说明集成测试的方法(从下而上或从上而下), 模块测试的顺序, 并给出辅助的模块或驱动模块
及测试用例, 说明这些测试用例的选取原则。
服务管理系统需求说明书 文档密级:机密
参考资料清单List of reference :
请罗列本文档所参考的有关参考文献和相关文档,格式如下:
作者+书名(或杂志、文献、文档)+出版社(或期号、卷号、公司文档编号)+出版日期+起止页码
例如:
[1] D. B. Leeson, “A Simple Model of Feedback Oscillator Noise Spectrum,” Proc. IEEE,
pp329-330, February 1966 (英文文章格式)
[2] D. Wolaver, Phase-Locked Loop Circuit Design, Prentice Hall, New Jersey,1991 (英文书籍
格式)
[3] 王阳元,奚雪梅等,“薄膜SOI/CMOS SPICE电路模拟”,电子学报,vol.22,No.5,1994 (中
文文章格式)
[4] 郑筠,《MOS存储系统及技术》,科学出版社,1990 (中文书籍格式)
[5] XXX,SDXXX用户手册 V1.1,基础部文档室,2001/4/26
2011-01-28 第11页,共11页Page 11 , Total11