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

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

《P8XX项目概要设计说明书含架构设计vXY.docx》由会员分享，可在线阅读，更多相关《P8XX项目概要设计说明书含架构设计vXY.docx（10页珍藏版）》请在冰豆网上搜索。

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

编号：

BC-GS-IV-PDD

版本：

v1.0

阶段标注：

P

EnjoyYourProduct

概要设计说明书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.1.1软件系统上下文定义

首先描述本软件系统在实际环境的组网方式（一般用图描述）

描述系统如何与外部实体一道组成功能实体（一般用图描述）

本节还要描述待开发软件系统与外部实体的关系.，可以使用系统架构图、顶层数据流图、事务图等来描述系统结构和交互关系。

所有系统外围实体（在设计规格流程中有定义），这些实体与软件系统发生交互作用或以某种方式影响软件系统，比如，操作系统，驱动程序，硬件，中断，其它软件系统等。

外围实体和本系统相互作用的性质（比如，消息，库调用）和类型（比如，OS服务，通信服务，系统工具等）。

描述外部实体的特性时要注意该描述一定要有助本软件的设计和描述。

为了本文档内容的完整性，可以采用对于描述相关设计实体文档索引的方式：

如对于操作系统编程手册的索引。

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.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数据分解

本节描述系统中的数据结构。

外部数据实体不必描述。

本章节描述本系统中用到的全局数据结构，其中至少包括：

各分解模块直接访问的数据，被各分解模块用来在接口中使用的结构。

描述数据时要注意该数据是否真正为本级模块分解的公用数据。

2.2.1.3.1数据实体1描述

按照以下格式描述：

标识：

类型：

目的：

2.2.1.3.2数据实体2描述

2.2.2依赖性描述

本节描述系统中的子系统，数据结构，模块，进程等设计实体间的关系。

依赖关系描述可以使用结构图（交互）事务图，消息序列图,ER图。

2.2.2.1运行设计

本章节描述本层设计的各个模块和进程是如何配合完成系统的功能需求.可以用消息序列图,（交互）事务图,结构图等进行描述,可以按照处理过程进行分节描述,要注意的是描述的内容应该涵盖所有SRS文档的功能需求,对于二级设计来讲,就是要涵盖分解对象模块的功能规格。

2.2.2.2数据依赖关系

本节描述数据结构间的关系。

依赖关系描述可以使用ER图。

2.2.3接口描述

本节描述软件系统中设计实体（如子系统，模块，进程）的接口.

接口描述可以使用接口文件，参数表。

对于外部实体只有同被描述软件相关的接口才需描述。

2.2.3.1模块/子系统接口

本节描述模块/子系统的接口。

2.2.3.1.1模块/子系统1提供的接口

对于接口函数，可以采用以下形式描述：

接口1：

形式：

输入：

输出：

返回：

描述返回什么。

描述：

总体描述该接口实现的目的。

2.2.3.1.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.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表项的删除

删除表项的动作步骤.该节的标题可以适当更改

2.4.5表项的更改

修改表项的动作步骤.该节的标题可以适当更改。

2.5数据库（可选）

2.5.1实体、属性及它们之间的关系

本节列出所有的数据存储类的实体，详细描述实体的内容和并列出全部属性。

对每个属性，详细描述其数据库、数据大小、特定约束。

实体的所有约束及实体间的关系也要注明。

2.5.2实体关系图

本节描述关于上节提到的所有实体的E-R图。

参考资料清单：

请罗列本文档所参考的有关参考文献和相关文档，格式如下：

作者＋书名（或杂志、文献、文档）＋出版社（或期号、卷号、公司文档编号）＋出版日期+起止页码

例如：

D.B.Leeson,“ASimpleModelofFeedbackOscillatorNoiseSpectrum,”Proc.IEEE,pp329-330,February1966（英文文章格式）

D.Wolaver,Phase-LockedLoopCircuitDesign,PrenticeHall,NewJersey,1991（英文书籍格式）

王阳元，奚雪梅等，“薄膜SOI/CMOSSPICE电路模拟”，电子学报，vol.22，No.5，1994（中文文章格式）

郑筠，《MOS存储系统及技术》，科学出版社，1990（中文书籍格式）

XXX，SDXXX用户手册V1.1，基础部文档室，2001/4/26

附录：

文档模板说明

1级标题

字体：

微软雅黑加粗二号

格式段落：

多倍行距设置值3其他0

2级标题

字体：

微软雅黑加粗小二

格式段落：

多倍行距设置值3其他0

3级标题

字体：

微软雅黑加粗三号

格式段落：

多倍行距设置值3其他0

4级标题

字体：

微软雅黑加粗小三

格式段落：

多倍行距设置值3其他0

5级标题

字体：

微软雅黑加粗四号

格式段落：

多倍行距设置值3其他0

6级标题

字体：

微软雅黑加粗小四

格式段落：

多倍行距设置值3其他0

7级标题

字体：

微软雅黑加粗小四

格式段落：

多倍行距设置值3其他0

8级标题

字体：

微软雅黑加粗小四

格式段落：

多倍行距设置值3其他0

9级标题

字体：

微软雅黑加粗五号

格式段落：

多倍行距设置值3其他0

正文格式：

字体：

微软雅黑小四

格式段落：

首行缩进2字符1.5倍行距

表格内文字格式：

表格标题：

微软雅黑加粗五号

表格标题底纹颜色：

灰色色值：

红黄蓝数值均为217

表格正文：

微软雅黑五号

正文样例文字编写格式：

字体：

微软雅黑斜体五号

表格标题底纹颜色：

灰色色值：

红黄蓝数值均为64

格式段落：

首行缩进2字符1.5倍行距

页眉页码格式：

封面格式：

无页码无页眉

文档更新记录页至目录页格式：

有页眉有页码页码设置为罗马数字：

ⅠⅡⅢ

页面低端居中位置

文档正文格式：

有页眉有页码页码设置为阿拉伯数字页面低端居中位置并显示当前页和总页数。