软件概要设计模板.doc

XX 概要设计说明书 目 录1简介41.1目的41.2范围41.2.1软件名称41.2.2软件功能41.2.3软件应用41.3实现系统环境41.3.1器件特性描述41.3.2器件工作原理介绍41.3.3关键寄存器介绍42概要设计52.1第0层设计描述52.1.1软件系统上下文定义52.1.2设计思路(可选)62.2第一层设计描述62.2.1系统架构（功能分解和物理分解）62.2.2功能实现与模块/子系统的关系72.2.3分解描述92.2.4接口描述92.3第二层设计描述（Optional）102.3.1模块1名称102.4132.5数据库（可选）132.5.1实体、属性及它们之间的关系132.5.2实体关系图132.6文件的组织142.6.1文件的命名方式142.6.2文件的组织目录结构14 XX 概要设计说明书 关键词：能够体现文档描述内容主要方面的词汇。 摘 要： 缩略语清单：对本文所用缩略语进行说明，要求提供每个缩略语的英文全名和中文解释。 缩略语 英文全名 中文解释1 简介1.1 目的 这部分要描述文档的目的。应该指明读者。1.2 范围1.2.1 软件名称 对软件命名1.2.2 软件功能 解释软件产品将完成或不完成的功能（可以直接描述也可以参考相关文档）1.2.3 软件应用 描述软件的应用（可直接描述也可以参考其他软件文档）1.3 实现系统环境 描述本软件的硬件应用平台（主要涉及关键器件的介绍和环境组网方式）1.3.1 器件特性描述 本器件所支持的规格、工作模式及其异同1.3.2 器件工作原理介绍The description of the work principle of the device we used in our solution.1.3.3 关键寄存器介绍The description of the registers used in the work mode our solution.2 概要设计 2.1 第0层设计描述2.1.1 软件系统上下文定义 描述系统如何与外部实体一道组成功能实体（一般用图描述）外部实体属性描述只限于软件设计和描述相关的属性。2.1.2 设计思路(可选) 2.1.2.1 基本设计思路说明系统采取的基本设计思路,概要描述为什么采取本方案。2.1.2.2 设计约束1 遵循标准 描述本软件所遵循的标准、规范2 硬件限制 描述本软件系统实现的硬件限制3 技术限制 描述本软件的技术限制2.1.2.3 安全性和可靠性设计方案4 遵循标准 描述本软件所遵循的标准、规范5 硬件限制 描述本软件系统实现的硬件限制6 技术限制 描述本软件的技术限制2.1.2.4 其他 描述其他有关的设计考虑2.2 第一层设计描述2.2.1 系统架构（功能分解和物理分解）描述组成软件系统的构件（子系统、模块），描述之间的“静态”关系。一般采用系统方框图的形式。要按照子系统组成系统，模块组成子系统的方式组织描述。系统方框图应能规定出系统的整体架构，说明组成系统的各部分是如何搭配成一个完整系统的。系统方框图应画成二种：一种是功能性的，说明系统有哪些功能？应由哪些功能模块来实现？画出这些功能模块之间、本系统与其它接口系统之间的逻辑关系； 描述它们间的接口方式， 遵循的协议规范等。 如果是升级类产品， 在原有功能方框框图上增加、删除、修改。 另一种是物理性的，说明系统由具体的哪些软件模块来实现。注：对于简单功能的软件系统，可省略“功能分解”（功能框图）这一步骤，而直接进行“物理分解”（物理框图）。可测性设计的整体结构描述也应在这里给出。说明整体系统可测性方面的层次结构，之间的逻辑关系，主要的功能接口定义，子系统、模块应具有的主要可测性规格与设计描述。2.2.2 功能实现与模块/子系统的关系 描述系统是如何运作以实现系统需求的。对于可测性性设计的功能，如果有单独的功能模块则在下面用单独的小节进行功能实现原理描述，如果只是某些功能需求的一部分功能，则在相应的功能需求中进行说明。 用如下矩阵图说明各项功能需求的实现与各模块/子系统的分配关系：模块/子系统 1模块/子系统2模块/子系统 n功能需求1功能需求2功能需求n 2.2.3 分解描述2.2.3.1 模块/子系统描述 1 模块/子系统 1描述Describe as follows 按照以下格式描述：Identification 标识：Type 类型：Purpose目的：Functions 功能列表：2.2.3.2 并发进程描述 本节描述系统中的并发进程。 对于外部实体，从属属性不必描述。1 进程1描述Describe as follows 按照以下格式描述：Identification 标识：Type 类型：Purpose目的：Functions 功能列表：2.2.3.3 数据描述 本节描述系统中的数据结构。 外部数据实体不必描述。1 数据实体1描述Describe as follows 按照以下格式描述：Identification 标识：Type 类型：Purpose目的： 2.2.4 接口描述 本节描述软件系统中设计实体(如模块/子系统）的接口. 接口描述可以使用接口文件，参数表。 对于外部实体只有同被描述软件相关的接口才需描述。2.2.4.1 模块/子系统接口 本节描述模块/子系统的接口。1 模块/子系统 1接口描述Describe as follows 按照以下格式描述：Identification 标识：Type 类型：Purpose目的：Functions 功能列表：2.2.4.2 进程接口 本节描述进程的接口。1 进程1接口描述Describe as follows 按照以下格式描述：Identification 标识：Type 类型：Purpose目的：Functions 功能列表：2.3 第二层设计描述（Optional） .L1中定义的每个实体的进一步设计在下面的章节进行描述。 对每个模块重复使用下述的格式。2.3.1 模块1名称 不要写直接“模块1名称”，用简短的词语命名模块.2.3.1.1 模块架构（物理分解）运用物理框图描述组成软件模块的构件（子模块），描述之间的“静态”关系。2.3.1.2 功能实现与子模块的关系 用如下矩阵图说明模块的功能需求的实现与各子模块的分配关系：子模块1子模块2子模块n模块的功能需求1模块的功能需求2模块的功能需求n 2.3.1.3 分解描述 描述模块的分解，并描述每个子模块的功能等属性。.1 子模块描述 a) 子模块 1描述Describe as follows 按照以下格式描述：Identification 标识：Type 类型：Purpose目的：Functions 功能列表：.2 并发进程描述 本节描述模块中的并发进程。 对于外部实体，从属属性不必描述。a) 进程1描述Describe as follows 按照以下格式描述：Identification 标识：Type 类型：Purpose目的：Functions 功能列表：.3 数据描述 本节描述模块中的数据结构。 外部数据实体不必描述。a) 数据实体1描述Describe as follows 按照以下格式描述：Identification 标识：Type 类型：Purpose目的： 2.3.1.4 接口描述描述模块内部的接口关系，如两个子模块间的接口等。接口描述可以使用接口文件，参数表。对于外部实体只有同被描述软件相关的接口才需描述。.1 子模块接口 本节描述子模块的接口。a) 子模块1接口描述Describe as follows 按照以下格式描述：Identification 标识：Type 类型：Purpose目的：Functions 功能列表：.2 进程接口 本节描述进程的接口。a) 进程1接口描述Describe as follows 按照以下格式描述：Identification 标识：Type 类型：Purpose目的：Functions 功能列表：2.42.5 数据库（可选）2.5.1 实体、属性及它们之间的关系 本节列出所有的数据存储类的实体，详细描述实体的内容和并列出全部属性。对每个属性，详细描述其数据库、数据大小、特定约束。实体的所有约束及实体间的关系也要注明。2.5.2 实体关系图This section should display the E-R diagram for all the entities listed above. 2.6 文件的组织2.6.1 文件的命名方式The description of the organization for the files and directory of code file. 2.6.2 文件的组织目录结构The description of the source code files directory organization2.6.3 参考资料清单：请罗列本文档所参考的有关参考文献和相关文档，格式如下：作者书名（或杂志、文献、文档）出版社（或期号、卷号、公司文档编号）出版日期+起止页码例如：1 D. B. Leeson, “A Simple Model