P8XX项目概要设计说明书含架构设计vXY.docx

1、P8XX项目概要设计说明书含架构设计vXY 编 号：BC-GS-IV-PDD 版 本：v1.0 阶段标注：PEnjoy Your Product概要设计说明书 vx.y XXX项目 编制： 审核： 标审： 会签： 批准： XXX有限公司2019年XX月更改历史页版本修订人审核人批准人生效日期更改内容v0.1创建1 简介1.1 目的这部分要描述文档的目的。应该指明读者。1.2 范围1.2.1 软件名称对软件命名1.2.2 软件功能解释软件产品将完成或不完成的功能（可以直接描述也可以参考相关文档）1.2.3 软件应用描述软件的应用（可直接描述也可以参考其它软件文档）2 概要设计2.1 第零层设计描

2、述2.1.1 软件系统上下文定义首先描述本软件系统在实际环境的组网方式（一般用图描述）描述系统如何与外部实体一道组成功能实体（一般用图描述）本节还要描述待开发软件系统与外部实体的关系.，可以使用系统架构图、顶层数据流图、事务图等来描述系统结构和交互关系。所有系统外围实体(在设计规格流程中有定义)，这些实体与软件系统发生交互作用或以某种方式影响软件系统，比如，操作系统，驱动程序，硬件，中断，其它软件系统等。外围实体和本系统相互作用的性质(比如，消息，库调用)和类型(比如，OS服务，通信服务，系统工具等)。描述外部实体的特性时要注意该描述一定要有助本软件的设计和描述。 为了本文档内容的完整性，可以

3、采用对于描述相关设计实体文档索引的方式：如对于操作系统编程手册的索引。2.1.2 设计思路(可选)2.1.2.1 设计方法描述本软件系统所采取的设计方法。2.1.2.2 设计可选方案对本软件系统的几种设计方案进行分析、比较，并确定所采用的方案2.1.2.3 设计约束2.1.2.3.1 遵循标准描述本软件所遵循的标准、规范2.1.2.3.2 硬件限制描述本软件系统实现的硬件限制2.1.2.3.3 技术限制描述本软件的技术限制2.1.2.4 其它描述其它有关的设计考虑2.2 第一层设计描述这里要描述软件系统的总体结构。总体结构描述可以使用结构图，层次分解图，自然语言。2.2.1 分解描述2.2.1

4、.1 模块/子系统分解本节描述系统中的子系统和模块。2.2.1.1.1 模块/子系统1描述按照以下格式描述：标识：类型：目的：功能列表：要实现的需求ID:子模块：如果本模块还要继续划分，列出下属子模块2.2.1.1.2 模块/子系统2描述2.2.1.2 并发进程处理分解本节描述系统中的并发进程。对于外部实体，从属属性不必描述。2.2.1.2.1 进程1描述按照以下格式描述：标识：类型：目的：功能列表：描述本进程中要完成的功能，如功能已经在前面的模块分解中有描述，则重点描述本进程完成了哪些模块的哪些功能。2.2.1.2.2 进程2描述2.2.1.3 数据分解本节描述系统中的数据结构。外部数据实体

5、不必描述。本章节描述本系统中用到的全局数据结构，其中至少包括： 各分解模块直接访问的数据，被各分解模块用来在接口中使用的结构。描述数据时要注意该数据是否真正为本级模块分解的公用数据。2.2.1.3.1 数据实体1描述按照以下格式描述：标识：类型：目的：2.2.1.3.2 数据实体2描述2.2.2 依赖性描述本节描述系统中的子系统，数据结构，模块，进程等设计实体间的关系。依赖关系描述可以使用结构图（交互）事务图，消息序列图, ER图。2.2.2.1 运行设计本章节描述本层设计的各个模块和进程是如何配合完成系统的功能需求. 可以用消息序列图, (交互)事务图, 结构图等进行描述, 可以按照处理过程

6、进行分节描述, 要注意的是描述的内容应该涵盖所有SRS文档的功能需求, 对于二级设计来讲, 就是要涵盖分解对象模块的功能规格。2.2.2.2 数据依赖关系本节描述数据结构间的关系。依赖关系描述可以使用ER图。2.2.3 接口描述本节描述软件系统中设计实体(如子系统，模块，进程）的接口.接口描述可以使用接口文件，参数表。对于外部实体只有同被描述软件相关的接口才需描述。2.2.3.1 模块/子系统接口本节描述模块/子系统的接口。2.2.3.1.1 模块/子系统1提供的接口对于接口函数，可以采用以下形式描述：接口1：形式：输入：输出：返回：描述返回什么。描述：总体描述该接口实现的目的。2.2.3.1

7、.2 模块/子系统2提供的接口2.2.3.2 进程接口本节描述进程的接口。2.2.3.2.1 进程1描述进程间的接口主要是描述一些共享内存，协议数据，消息等。按照以下格式描述：标识：类型：目的：功能列表：2.2.3.2.2 进程2描述2.3 第二层设计描述（可选）中定义的每个实体的进一步设计在下面的章节进行描述。对每个模块重复使用下述的格式(和一层设计一样)。具体的编写建议参见第一层设计。2.3.1 模块1名称2.3.1.1 分解描述2.3.1.1.1 模块/子系统分解1） 模块/子系统1描述2） 模块/子系统2描述2.3.1.1.2 并发进程处理分解1） 进程1描述2） 进程2描述2.3.1

8、.2 数据实体描述按照以下格式描述模块内部使用的多个数据实体：标识：类型及组成结构（必要的话）：目的：2.3.1.3 依赖性描述2.3.1.3.1 运行设计2.3.1.3.2 数据依赖关系2.3.1.4 接口描述2.3.1.4.1 模块/子系统接口1） 模块/子系统1提供的接口2） 模块/子系统2提供的接口2.3.1.4.2 进程接口1） 进程1描述2） 进程1描述2.3.2 模块2名称2.4 配置和控制（可选）2.4.1 启动描述启动一个模块的步骤2.4.2 关闭描述关闭一个模块的步骤2.4.3 表项的创建创建新表项的动作步骤。该节的标题可以适当更改2.4.4 表项的删除删除表项的动作步骤.

9、 该节的标题可以适当更改2.4.5 表项的更改修改表项的动作步骤. 该节的标题可以适当更改。2.5 数据库（可选）2.5.1 实体、属性及它们之间的关系本节列出所有的数据存储类的实体，详细描述实体的内容和并列出全部属性。对每个属性，详细描述其数据库、数据大小、特定约束。实体的所有约束及实体间的关系也要注明。2.5.2 实体关系图本节描述关于上节提到的所有实体的E-R图。参考资料清单：请罗列本文档所参考的有关参考文献和相关文档，格式如下：作者书名（或杂志、文献、文档）出版社（或期号、卷号、公司文档编号）出版日期+起止页码例如：D. B. Leeson, “A Simple Model of Fe

10、edback Oscillator Noise Spectrum,” Proc. IEEE, pp329-330, February 1966 （英文文章格式）D. Wolaver, Phase-Locked Loop Circuit Design, Prentice Hall, New Jersey,1991 （英文书籍格式）王阳元，奚雪梅等，“薄膜SOI/CMOS SPICE电路模拟”，电子学报，vol.22，No.5，1994 （中文文章格式）郑筠，MOS存储系统及技术，科学出版社，1990 （中文书籍格式）XXX，SDXXX用户手册 V1.1，基础部文档室，2001/4/26 附录：文

11、档模板说明1级标题字体：微软雅黑 加粗 二号格式段落：多倍行距 设置值 3 其他02级标题字体：微软雅黑 加粗 小二格式段落：多倍行距 设置值 3 其他03级标题字体：微软雅黑 加粗 三号格式段落：多倍行距 设置值 3 其他04级标题字体：微软雅黑 加粗 小三格式段落：多倍行距 设置值 3 其他05级标题字体：微软雅黑 加粗 四号格式段落：多倍行距 设置值 3 其他06级标题字体：微软雅黑 加粗 小四格式段落：多倍行距 设置值 3 其他07级标题字体：微软雅黑 加粗 小四格式段落：多倍行距 设置值 3 其他08级标题字体：微软雅黑 加粗 小四格式段落：多倍行距 设置值 3 其他09级标题字体：微软雅黑 加粗 五号格式段落：多倍行距 设置值 3 其他0正文格式：字体：微软雅黑 小四格式段落：首行缩进2字符 1.5倍行距表格内文字格式：表格标题：微软雅黑 加粗 五号表格标题底纹颜色：灰色 色值：红黄蓝数值均为217表格正文：微软雅黑 五号正文样例文字编写格式：字体：微软雅黑 斜体 五号表格标题底纹颜色：灰色 色值：红黄蓝数值均为64格式段落：首行缩进2字符 1.5倍行距页眉页码格式：封面格式：无页码无页眉文档更新记录页至目录页格式：有页眉有页码 页码设置为罗马数字： 页面低端居中位置文档正文格式：有页眉有页码 页码设置为阿拉伯数字 页面低端居中位置并显示当前页和总页数。