软件设计说明书模板V10

1、至诚概要设计说明书密级：内部公开XX 概要设计说明书拟制日期yyyy-mm-dd审核日期yyyy-mm-dd批准日期yyyy-mm-dd深圳中电数通科技有限公司版权所有 侵权必究文档修订记录日期版本号变化状态变更说明作者说明：变化状态包括：创建，增加，修改，删除;变更说明应该描述文档变更的原因，如果是由于CR导致的变更必须列出具体的CR号，变更的章节也应该标出。目 录1简介61.1文档目的61.2适用范围61.3产品信息61.4软件名称与功能62总体设计62.1需求规定62.2运行环境62.3开发环境72.4设计思想72.5系统结构72.6处理流程72.7功能实现与模块的关系72.8模块开发方

2、式说明73模块设计83.1模块1(名称)83.1.1功能和性能83.1.2输入83.1.3输出83.1.4复用说明83.1.5接口说明83.2模块2(名称)83.2.1功能和性能83.2.2输入83.2.3输出83.2.4复用说明94接口设计94.1外部接口94.1.1用户界面94.1.2硬件接口94.1.3软件接口94.1.4通讯接口94.2内部接口95运行设计106属性设计106.1性能106.2可靠性106.3安全性106.4可维护性107逻辑数据结构107.1逻辑结构设计要点107.2数据结构与模块的关系108物理数据结构(可选)118.1FLASHROM的分配118.2RAM的分配1

3、18.3NVROM的分配118.4IC卡的地址分配119系统出错处理1110系统调试与测试方法1110.1调试方法1110.2测试方法1111参考资料 (可选)12术语和缩略语表对文中使用的术语和缩略语进行说明。如果是英文缩略语要求提供英文全名,并在说明栏中提供中文解释,对于术语则在说明中加以解释 缩略语/术语全称说明1 简介1.1 文档目的简要说明编写本文档的目的。1.2 适用范围本文档适用于哪些人员、哪些项目、哪些领域等。1.3 产品信息产品名称：产品型号：1.4 软件名称与功能说明本文档对应的软件的正式名称和版本号，或各部分的文件名和版本号,解释软件产品实现的功能。2 总体设计若提供了系

4、统总体设计说明书，则这部门可略掉，直接参考系统总体设计说明书的内容。2.1 需求规定说明对本系统的主要的输入输出项目、处理的功能性能要求。2.2 运行环境简要地说明对本系统的运行环境（包括硬件环境和支持环境）的规定2.3 开发环境详细说明开发和调试/测试该软件所需的硬件环境和软件环境。2.4 设计思想针对需求，说明软件的全局设计思想（如面向实时、面向对象、面向数据、事件驱动等）和实现方法。2.5 系统结构用一览表及框图的形式说明本系统的系统元素（各层模块、子程序、公用程序等）的划分，扼要说明每个系统元素的标识符和功能，分层次地给出各元素之间的关系（控制、顺序、信号传递等关系。）2.6 处理流程

5、说明本系统的处理流程，包括信息处理流程、功能实现过程、资源调配过程和进程控制流程等。使用流程图的形式说明。 2.7 功能实现与模块的关系用如下矩阵图说明各项功能需求的实现同各模块的分配关系：模块1模块2模块n功能需求1功能需求2功能需求n2.8 模块开发方式说明用列表说明各模块的开发方式（新开发、移植、改进、直接使用、外协开发等）。3 模块设计3.1 模块1(名称)3.1.1 功能和性能说明该模块所实现的功能以及对该模块的性能要求（资源占用、运行效率等）。3.1.2 输入给出本模块输入参数的详细说明, 包括取值范围、含义，参数间的控制、顺序、独立或依赖等关系。说明模块的入口数。对输入参数是否应

6、进行检验，对输入参数应明确定义相应的数据结构。3.1.3 输出给出本模块输出参数的详细说明（输出参数不包含模块的返回值），包括它的输出值、取值范围、含义及参数间的控制、顺序、独立或依赖等关系。说明模块的出口数。对输出参数应明确定义相应的数据结构。3.1.4 复用说明给出本模块必须复用和建议复用的模块名称和获取方式，同时给出将要复用本模块的模块清单。3.1.5 接口说明给出本模块与其它模块或子系统之间交互的接口,如果存在的话需要详细说明接口的输入参数的数目、类型及合法的取值范围及输出参数,并说明异常处理情况。3.2 模块2(名称)3.2.1 功能和性能说明该模块所实现的功能以及对该模块的性能要求

7、（资源占用、运行效率等）。3.2.2 输入给出本模块输入参数的详细说明, 包括取值范围、含义，参数间的控制、顺序、独立或依赖等关系。说明模块的入口数。对输入参数是否应进行检验，对输入参数应明确定义相应的数据结构。3.2.3 输出给出本模块输出参数的详细说明（输出参数不包含模块的返回值），包括它的输出值、取值范围、含义及参数间的控制、顺序、独立或依赖等关系。说明模块的出口数。对输出参数应明确定义相应的数据结构。3.2.4 复用说明给出本模块必须复用和建议复用的模块名称和获取方式，同时给出将要复用本模块的模块清单。4 接口设计4.1 外部接口4.1.1 用户界面说明软件的用户界面设计要求。4.1.

8、2 硬件接口陈述软件产品与系统硬件设备之间每一个接口的逻辑特点。还可能包括如下事宜: 要支持什么样的设备，如何支持这些设备，如何约定等。4.1.3 软件接口说明本系统同外界的所有软件接口、本系统与各支持软件之间的接口关系,如果存在的话需要详细说明接口的输入参数的数目、类型及合法的取值范围及输出参数,并说明异常处理情况。4.1.4 通讯接口说明各种通讯接口。例如串口协议、局部网络协议等。4.2 内部接口说明软件内部各模块之间主要的信息交换或控制接口以及这些接口的作用, 如果存在的话需要详细说明接口的输入参数的数目、类型及合法的取值范围及输出参数,并说明异常处理情况。5 运行设计说明软件的运行控制

9、设计，包括有关中断结构、进程控制、执行顺序、程序状态转换等的设计思想，并说明采用这些设计思想的原因。对于实时处理系统或交互系统来说，该部分的设计思想非常重要。6 属性设计6.1 性能 说明对于该产品的性能要求，如：开机时间、升级时间、应用启动时间、换台时间、遥控器和前面板按键的响应速度等。6.2 可靠性软件的可靠性指在硬件稳定的条件下，经过长时间运行和各种误操作输入（不含硬件误操作）情况下的稳定程度，其中主要包括故障处理能力、边界值处理能力和误操作屏蔽能力等。说明设计中保证可靠性的设计方案。6.3 安全性这里指的是保护软件的要素，以防止各种非法的访问、使用，修改、破坏或者泄密等。包括数据安全性

10、和网络安全性等。6.4 可维护性 说明为了系统维护的方便而在程序内部设计中作出的安排，包括在程序中专门安排用于系统的检查与维护的检测点和专用模块。可维护性包括可移植性、可修改性、可扩充性等。可移植性是指在不同的硬件或软件平台上移植的方便程度；可修改性指软件的可读程度和软件出现问题时修改的方便性；可扩充性指软件对外接口和内部功能扩展的灵活性。说明保证软件可维护性的设计措施。7 逻辑数据结构7.1 逻辑结构设计要点包括常规的数据结构、被封装的数据结构（对象）和数据库（如果有的话）。7.2 数据结构与模块的关系采用表格说明上述数据结构与主要软件模块之间的关系。软件模块与这些数据结构的关系包括创建（C

11、reate），更新（Update），读出（Read）和发消息（Send Message）等。8 物理数据结构(可选)8.1 FLASHROM的分配描述FLASHROM的地址分配8.2 RAM的分配8.3 NVROM的分配8.4 IC卡的地址分配9 系统出错处理用一览表的方式说明每种可能的出错或故障情况出现时，系统输出信息的形式、含意及对这些情况的处理设计。可能出现的出错类别包括接收到错误数据、硬件出现故障和程序进入非正常状态等情况。10 系统调试与测试方法10.1 调试方法简要说明软件开发过程中的基本调试方法。10.2 测试方法简要说明软件基本成形后对其进行测试的基本方法。11 参考资料 (可

12、选)编写本文档时引用或参考的文档资料、有关标准等。建议格式如下:作者书名（或杂志、文献、文档）出版社（或期号、卷号、公司文档编号）出版日期+起止页码例如:1 郑宁,天昊,葛灜龙,林菲,张万军, 基于CMMI的软件工程实训指导,清华大学出版社,2008（中文书籍格式）2 赖涵, CMMI模型与评估方法浅析,重庆工商大学 学报(自然科学版), vol.24，No.2，2007 （中文文章格式）3 Mary Beth Chrissis, Mike Konrad, Sandy Shrum, CMMI®: Guidelines for Process Integration and Product Improvement, Addison Wesley,2003 (英文书籍格式)4 SALAMA H,REEVES D,VINIOTIS Y