04 CDSHLDXX项目XXXXX概要设计模板V0095Word格式文档下载.docx

04 CDSHLDXX项目XXXXX概要设计模板V0095Word格式文档下载.docx

《04 CDSHLDXX项目XXXXX概要设计模板V0095Word格式文档下载.docx》由会员分享，可在线阅读，更多相关《04 CDSHLDXX项目XXXXX概要设计模板V0095Word格式文档下载.docx（13页珍藏版）》请在冰点文库上搜索。

一般建议表示为Vm.n形式。

通过正式评审后版本号变为1.0，以后每修改一次n相应增加1，例如V1.1

作者：

填写文档的创建者或授权的修改人

日期：

填写编写本文档的编写或修订日期

描述：

请详细填写修改原因和最近的修改章节摘要

审核人：

描述文档本此版本的审核人

状态：

描述本文档是正式文件还是草稿文件

1.文档说明

1.1编制说明

本文档是<

XXX客户名称>

的<

XXXX项目名称>

项目中的<

XXX系统/产品>

概要设计说明书，通过对设计的思路、系统的架构、系统的各个构件之间的协作的描述，以满足上游的需求，同时，为组成本系统的每个构件的需求开发、构件间接口定义工作提供必要的基础。

本概要设计说明书有助于实现以下目标：

1.针对系统需求明确架构设计、标准化设计、开发和运行环境使用的关键技术；

2.为系统的详细设计提供依据和指导。

1.2适用对象

项目中XXXXX的概要设计说明书，<

作为XXX项目交付的重要组成部分>

，适用本文档各方包括但不限于：

3.<

XXXX客户名称>

：

包括XXXX,XXX,XXXX具体的部门；

4.项目建设的咨询方和监理方；

5.总集成商、分系统承建方、供应商、合作伙伴和原系统承建单位等。

本概要设计说明书适用于上海XXX股份股份有限公司XXXXX项目组的所有成员，以及<

XXX客户>

的相关人员，具体包括：

1.<

本系统相关人员：

a）XXXX的使用人员

b）XXXXX的技术人员

c）项目建设的其他人员

2.项目总集成商和承建方相关人员：

a）XXX股份项目的总集成人员

b）XXX股份本系统的需求分析师

c）XXX股份本系统的系统架构师

d）XXX股份本系统的研发人员

e）XXX股份本系统的测试人员

f）XXX股份本系统的实施人员

g）XXX股份本系统的维护人员

1.3术语定义

缩写，术语

解释

HLD

Highleveldesign（概要设计说明书）

构件

组成本系统的一些小的部件类型，可以是一些常规意义上的子系统，也可以是一些常规意义上的模块。

1.4起草单位

上海XXX股份股份有限公司。

1.5参考资料

1.《XXXXX需求说明书》

2.《XXXXXXX》

3.……

2.概述

2.1项目背景

<

简要描述项目背景>

2.2系统简述

简述系统的主要业务功能>

2.2.1网络架构[可裁剪]

描述本系统在网络架构中的位置和部署规划。

此处，不关注本系统的具体实现，需要关注本系统在即将部署的网络架构中的位置。

对于产品研发类的概要设计文档，本节可裁剪>

2.2.2本系统与外围系统的关系[可裁剪]

描述本系统与外围系统的关系，用图例和语言结合的方式描述。

此处，不关注本系统的具体实现，需要关注本系统与网络架构中已有系统和模块的交互及关系。

>

2.3范围

对《需求规格说明书》进行复审，如有变更需要在本节进行说明。

以下内容描述软件概要设计的整体范围，其主要信息来自于《需求规格说明书》。

2.3.1系统主要目标

描述系统的目标>

2.3.2主要软件需求

描述软件需求>

2.3.3设计约束、限制

描述约束和限制>

3.总体设计

3.1基本设计概念[可裁剪]

描述整体设计是用到的一些基本概念，并给出解释说明>

3.2设计思路[可裁剪]

描述在进行总体设计时的基本考虑。

在设计过程中，可能需要的一些重要考虑见3级标题。

设计思路可根据实际进行裁剪>

3.2.1软件架构的考虑[可裁剪]

可从如下方面进行阐述：

1.识别可供选择或集成的系统架构，形成几种候选方案；

2.识别影响系统架构选择的因素；

3.根据识别的关键因素，对得到的几种框架方案进行最后的挑选和完善。

3.2.2系统动态性设计的考虑[可裁剪]

如线程、进程、系统的分布考虑等。

3.2.3关键技术的考虑[可裁剪]

可从如下方面阐述：

1.说明本系统中可能存在的技术难点。

2.说明这些技术难点采用或选择的关键技术。

3.说明采用的关键技术对系统设计的影响。

3.2.4扩展性的考虑[可裁剪]

可从如下方面描述：

1.预计会增加或发生变化的需求。

2.针对可能变化的部分，选用合适的设计模式来应付这种变化。

3.2.5安全性考虑[可裁剪]

1.操作的安全性。

2.数据库的安全性。

3.文件的安全性。

3.2.6部署的考虑[可裁剪]

可以从如下方面阐述：

1.架构的选择。

2.系统在各个硬件上的部署策略。

3.多系统之间通讯的特殊考虑。

3.2.7复用和外购的考虑[可裁剪]

可以从以下方面描述：

1.本系统哪些构建不需要重新开发，是直接复用或者外购。

2.复用或外购决策的理由

3.对复用或外购件的维护方式>

4.架构说明

本章描述软件的系统架构，需要说明本系统的组成结构，即都有哪些构件、构件间/构件和系统外都有哪些接口。

注意本章不应该说明得到这些个分解结果的原因，这些原因信息应该在“设计思路”一章中具体说明。

对本章的内容组织，至少应该提供如下信息：

1.软件系统架构示意图。

图中要清楚表明本系统的范围，以及系统被划分成哪些构件，以及这些构件间存在哪些接口、这些构件和系统外存在哪些接口。

4.1节描述

2.各构件的属性的说明表格。

表格中对每个构件列出构件标识、构件名称、构件主要功能概述等信息。

4.2节描述

3.构件间/构件和系统外各接口的属性的说明表格。

表格中对每个接口列出全局标识、类型（和本系统外部的接口还是本系统内的构件间接口）、接口连接的构件、功能概述等信息。

4.3节描述

鉴于软件架构有多种类型的表现形式，本章可根据实际情况进行裁剪或新增内容。

4.1系统架构图

软件系统架构示意图要清楚表明本系统的范围，以及系统被划分成哪些构件，以及这些构件间存在哪些接口、这些构件和系统外存在哪些接口。

4.2子系统/模块划分说明

描述系统/软件的各个构件（子系统、模块）的说明，需要涵盖4.1节系统架构图中全部构件。

具体描述方式可采用如下形式的表格，也可以自拟，表格说明：

构件标识：

为每个子系统或模块定义全局标识>

构件说明清单：

构件标识

构件名称

类型

构件功能概述

备注

UIS

用户界面支持子系统

子系统

用户的直接操作界面，为用户提供包括字符和图形两种方式，它把用户从键盘输入的指令进行预处理后，发送到命令解析功能。

NC

网络通信模块

模块

……..

4.3功能需求追溯

本节说明《需求规格说明书》中的各项功能需求已在软件体系结构中得到分配。

可用如下的二维表说明各项功能需求与软件模块的对应关系。

模块1

模块2

……

模块M

功能需求1

√

功能需求2

功能需求m

此表可以采用其他适用形式,如拆分为两张表：

功能需求对应模块、模块对应功能需求，示例如下。

也可根据实际情况自拟>

对应的模块

对应的功能需求

模块m

4.4处理流程[可裁剪]

描述系统/软件的各个子系统或模块之间的关系和处理流程>

5.需求设计

5.1功能

5.1.1<

功能1>

本节描述各构件（系统、子系统、模块）通过相互协作完成本系统的功能需求的相关信息。

一般要从两个角度来考虑：

a）首先需要针对上游文档中的每条功能需求，描述在系统分成多个模块或构件的情况下，各构件（系统、子系统、模块）分别承担怎样的职责来彼此协作以继续满足功能需求的。

关于功能协作的含义，用个小例子来帮助说明，假设上游功能需求中有个用户登录功能，上游的描述中并不关心本系统是如何实现的，因此描述说用户输入用户名和密码，系统验证后给予响应，但现在假设本系统被分成了两个构件，分别是“用户接口”和“数据维护”，则这个过程也就更加详细，包括“用户接口”向“数据维护”发送请求，“数据维护”向“用户接口”发送响应的过程。

其中表明，“用户接口”构件承担了和用户交互的职责，“数据维护”构件承担了用户校验的职责。

大致过程见示意图。

功能协作在具体描述上，可采用示意图加文字的方式，不需要非常严谨，但应该很好地说明职责分配的过程。

在描述中需要注意：

a）一般至少给出一张协作图或顺序图，说明在完成该功能的主要过程（需求中的正常过程）上各构件的协作关系。

b）用文字对图例进行解释，说明协作形成理由的阐述（即为什么要这样分配职责）。

此外，需要描述整个协作的全过程，示例如下。

描述形式也可自拟

功能描述

用户登录

Actor

用户

优先级

5

使用频度

经常

前置条件

C0001登录端服务器通信正常

C0002用户有合法用户名和密码

正常过程

N0001用户打开登录界面

N0002在界面输入用户名密码

N0003用户接口收到用户名和密码信息，并发送到数据维护模块进行验证

N0004数据维护模块验证通过后，返回验证成功消息给用户接口

N0005用户登录成功

异常过程

E0001用户打开登录界面

E0002在界面输入用户名密码

E0003用户接口收到用户名和密码信息，并发送到数据维护模块进行验证

E0004数据维护模块验证未通过，返回验证失败消息给用户接口

E0005用户接口根据验证失败的类型，在用户界面显示失败提示信息。

特殊需求

c）如果功能的完成只涉及一个构建（系统、子系统、模块），则直接简单说明涉及一个构建，并文字描述功能完成的正常或异常过程。

不需要协作图。

5.1.2<

功能n>

5.2性能[可裁剪]

5.2.1<

性能1>

本节描述各构件通过相互合作能够完全满足所需的本系统的性能需求。

在编写本节的内容时，需要针对上游文档中的性能需求，描述在本系统分成多个构件的情况下，是如何满足性能需求的。

对本系统的性能需求，要求明确分解到组成本系统的各构件的“性能需求”上。

例如：

4.2.1PD-SPS-CR-0090RAM资源限制

在系统的最大容量下的正常工作情况下，本系统在运行中将存在128个Cell构件的实例，1个CallManager构件的实例，1个ResourceManager构件的实例，2048个Call构件的实例。

分给本系统的32MBRAM将这样分配：

Cell32KBx128=4MB

CallManager2MBx1=2MB

ResourceManager2MBx1=2MB

Call12KBx2048=24MB

5.2.2<

性能n>

5.3非功能性需求[可裁剪]

本节用于描述各个构件通过相互合作能够完全满足所需的本系统的XX需求。

XX需求需要和上游文档中具体的需求类别相对应。

6.接口设计

如果出专门的系统接口说明书，则本章可裁剪。

本章内容是对4.3节内容的详细说明>

6.1外部接口

6.1.1<

外部接口标识<

构件1>

外部接口>

描述接口的作用，接口的内容。

接口内容可以用表格形式描述，格式自拟。

例如：

序号

消息名称

流向

承载于

引用

1

2

6.1.2<

构件n>

6.2内部接口

6.2.1<

内部接口标识<

构件x>

和<

构件y>

间接口>

7.用户界面设计

和用户交互的最终界面在《详细设计说明书》中设计，在此界面设计风格进行设计和描述>

8.出错处理设计

本章简要描述可能的出错和故障情况下，系统对错误的处理方法。

可以用表格的方式说明，格式自拟，例如>

出错类别

出错处理

例如，对服务器宕机等情况，说明将使用的恢复或再启动技术,使软件从故障点恢复执行或软件从头开始重新运行的方法。

9.安全保密设计[可裁剪]

描述安全保密方案，权限的设置，保密算法，软件的实现方法等>