华为概要设计模板.docx

华为概要设计模板.docx

《华为概要设计模板.docx》由会员分享，可在线阅读，更多相关《华为概要设计模板.docx（12页珍藏版）》请在冰豆网上搜索。

华为概要设计模板

产品名称Productname

密级Confidentialitylevel

产品版本Productversion

Total16pages共16页

XXHighLevelDesignSpecification

XX概要设计说明书

Preparedby

拟制

Name+ID

姓名+工号

Date

日期

yyyy-mm-dd

Reviewedby

评审人

Date

日期

yyyy-mm-dd

Approvedby

批准

Date

日期

yyyy-mm-dd

XXXXCo.,Ltd.

XXXX有限公司

RevisionRecord修订记录

Date

日期

RevisionVersion

修订

版本

CRID/DefectID

CR号

SecNo.

修改

章节

ChangeDescription

修改描述

Author

作者

Catalog目录

1Introduction简介6

1.1Purpose目的6

1.2Scope范围6

1.2.1Name软件名称6

1.2.2Functions软件功能6

1.2.3Applications软件应用6

2HighLevelDesign概要设计6

2.1Level0DesignDescription第零层设计描述6

2.1.1SoftwareSystemContextDefinition软件系统上下文定义6

2.1.2DesignConsiderations（Optional）设计思路（可选）7

2.2Level1DesignDescription第一层设计描述8

2.2.1DecompositionDescription分解描述8

2.2.2DependencyDescription依赖性描述9

2.2.3InterfaceDescription接口描述10

2.3Level2DesignDescription（Optional）第二层设计描述（可选）12

2.3.1Modulename

（1）模块1名称12

2.3.2Modulename

（2）模块2名称13

2.4ConfigurationandControl（Optional）配置和控制（可选）14

2.4.1Startup启动14

2.4.2Closing关闭14

2.4.3CreatingMIBTableItemMIB表项的创建14

2.4.4DeletingMIBTableItemMIB表项的删除14

2.4.5ModifyingMIBTableItemMIB表项的更改14

2.5Database（Optional）数据库（可选）14

2.5.1Entity,Attributesandtheirrelationships实体、属性及它们之间的关系14

2.5.2E-Rdiagram实体关系图14

TableList表目录

Table1**表错误！

未定义书签。

表1**表错误！

未定义书签。

FigureList图目录

Figure1**图错误！

未定义书签。

图1**图错误！

未定义书签。

XXHighLevelDesignSpecification

XX概要设计说明书

Keywords关键词：

Abstract摘要：

Listofabbreviations缩略语清单：

<对本文所用缩略语进行说明，要求提供每个缩略语的英文全名和中文解释。

Describeabbreviationsinthisdocument,fullspellingoftheabbreviationandChineseexplanationshouldbeprovided.>

Abbreviations缩略语

Fullspelling英文全名

Chineseexplanation中文解释

1

Introduction简介

1.1Purpose目的

Thissectionshouldstatethepurposeofthedocument.Itcouldalsospecifytheintendedaudience.

这部分要描述文档的目的。

应该指明读者。

1.2Scope范围

1.2.1Name软件名称

Identifythesoftwarebyname

对软件命名

1.2.2Functions软件功能

Explainwhatthesoftwareproduct（s）willandwillnotdo（eitherdirectlyorbyreferencetoanothersoftwaredocument）.

解释软件产品将完成或不完成的功能（可以直接描述也可以参考相关文档）

1.2.3Applications软件应用

Describetheapplicationoftheproduct（eitherdirectlyorbyreferencetoanothersoftwaredocument）

描述软件的应用（可直接描述也可以参考其它软件文档）

2HighLevelDesign概要设计

2.1Level0DesignDescription第零层设计描述

2.1.1SoftwareSystemContextDefinition软件系统上下文定义

Describesthenetworkorganizingmodeofthesoftwaresysteminactualenvironment（usuallyindrawings）.

Describeshowthesoftwaresystemformsafunctionalentitywithotherexternalentities（usuallyindrawings）.

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

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

Thissectiondescribesrelationshipsbetweenthesoftwaresystemtobedevelopedandexternalentities.ArchitectureDiagram,ToplevelDFD（Data-Flow-Diagram）ortransactiondiagramscanbeusedtodescribearchitectureandinteraction.

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

Allexternalentitiesofthesoftwaresystem（definedinProcedureofDesignSpecification）thatinteractwiththesoftwaresystem,oraffectthesoftwaresysteminacertainmode,forexample,OS,driver,hardware,interruptorothersoftwaresystems.

Theproperty（suchasmessage,libraryinvoking）andtype（suchasOSservice,communicationservice,systemtools,etc.）oftheinteractionbetweenexternalentitiesandthissystem.Onlythecontentsthatarehelpfulinthesoftwaredesignshouldbeincludedwhiledescribingthefeaturesofanexternalentity.Insteadofacompletedescriptioninthisspecification,youcanmakeindexestorefertotherelativedocumentsthatdescribethesoftwaredesign.Forexample,anindexcanbemadefortheprogrammingguidanceoftheOS.

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

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

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

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

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

2.1.2DesignConsiderations（Optional）设计思路（可选）

2.1.2.1DesignMethodology设计方法

Describedesignmethodologythatshallbeusedinthesoftwaresystemdesign.描述本软件系统所采取的设计方法。

2.1.2.2DesignAlternatives设计可选方案

Analysisseveralalternativesofsystemdesignscheme,andspecifytheschemethatshallbeused.对本软件系统的几种设计方案进行分析、比较，并确定所采用的方案

2.1.2.3DesignConstraints设计约束

1Standardscompliance遵循标准

Describestandardsthatsoftwaresystemshallcomplywith.描述本软件所遵循的标准、规范

2HardwareLimitations硬件限制

Describehardwarelimitationsofthesoftwaresystem.描述本软件系统实现的硬件限制

3TechnologyLimitations技术限制

Describetechnologylimitationsofthesoftwaresystem.描述本软件的技术限制

2.1.2.4OtherDesignConsiderations其它

Describeotherdesignconsiderationsofthesoftwaresystem.描述其它有关的设计考虑

2.2Level1DesignDescription第一层设计描述

Architectureofthesoftwaresystemshallbedescribedhere.这里要描述软件系统的总体结构。

Structurechart,Hierarchicaldecompositiondiagram,naturallanguagecanbeusedtorepresentthearchitecture.总体结构描述可以使用结构图，层次分解图，自然语言。

2.2.1DecompositionDescription分解描述

2.2.1.1Module/SubsystemDecomposition模块/子系统分解

Thissectiondescribessubsystems,moduleinthesystem..本节描述系统中的子系统和模块。

1Module/Subsystem1Description模块/子系统1描述

Describeasfollows按照以下格式描述：

Identification标识：

Type类型：

Purpose目的：

Functions功能列表：

RequirementIDstoimplement要实现的需求ID:

Submodules:

子模块：

Ifthismodulewillbefurtherdecomposedintosubmodules,listallsubmoduleshere.如果本模块还要继续划分，列出下属子模块

2Module/Subsystem2Description模块/子系统2描述

2.2.1.2ConcurrentProcessDecomposition并发进程处理分解

Thissectiondescribesconcurrentprocessesinthesystem..本节描述系统中的并发进程。

Incaseofexternalentities,Subordinatesattributeneednotbedescribed.对于外部实体，从属属性不必描述。

1Process1Description进程1描述

Describeasfollows按照以下格式描述：

Identification标识：

Type类型：

Purpose目的：

Functions功能列表：

Thispartdescribesthefunctionstobeperformedintheprocess.Ifthefunctionhasbeendescribedinmoduledecompositionbefore,descriptionshouldbemadeonwhatfunctionsofthemodulesareimplementedinthisprocess.

描述本进程中要完成的功能，如功能已经在前面的模块分解中有描述，则重点描述本进程完成了哪些模块的哪些功能。

2Process2Description进程2描述

2.2.1.3DataDecomposition数据分解

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

Externaldataentitiesshallnotbedescribed.外部数据实体不必描述。

Describestheglobaldatastructureofthesystem,including:

thedatadirectlyaccessedbydecomposedmodules,andthedatastructureusedininterfaceofdecomposedmodules.Whendescribingthedata,makesurethedataistheglobaldataofthelevel.

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

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

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

1DataEntity1Description数据实体1描述

Describeasfollows按照以下格式描述：

Identification标识：

Type类型：

Purpose目的：

2DataEntity2Description数据实体2描述

2.2.2DependencyDescription依赖性描述

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

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

2.2.2.1RunningDesign运行设计

Thissectiondescribeshowthemodulesandtheprocessesofthisdesignlevelcooperatetoperformthefunctionalrequirementsofthesystem.MSC,transactiondiagrams,Structurechartscanbeusedtorepresenttherunningprocedure.Note:

AllthefunctionalrequirementsinSRSshouldbecoveredinthedescription.ForLevel2,Functionspecificationofthemoduletobedecomposedshouldbecovered.

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

2.2.2.2DataDependencies数据依赖关系

Thissectiondescribesrelationshipsamongdatastores。

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

ERdiagramcanbeusedtorepresentdependences.

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

2.2.3InterfaceDescription接口描述

Thissectiondescribesinterfacesofthedesignentities（suchassubsystem,module,process）thatmakeupthesystem。

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

Interfacefiles,parametertablescanbeusedtodescribeInterface.

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

Incaseofexternalentities,onlytheinterfacesrelevanttothesoftwarebeingdescribedneedbedescribed.

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

2.2.3.1Module/SubsystemInterfaces模块/子系统接口

ThissectiondescribesinterfacesofModule/SubsystemInterfaces。

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

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

Forinterfacefunction,followingformatshouldbeused:

Interface1:

Format:

Input:

Output:

Return:

Describesthereturnvalueofthefunction

Description:

Describestheobjectiveoftheinterface.

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

接口1：

形式：

输入：

输出：

返回：

描述返回什么。

描述：

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

2InterfacesProvidedbyModule/Subsystem2模块/子系统2提供的接口

2.2.3.2ProcessInterfaces进程接口

Thissectiondescribesinterfacesofprocess。

本节描述进程的接口。

1Process1Description进程1描述

Theinterfacesbetweentheprocessesdescribethesharedmemory,protocoldataandmessages,etc.

进程间的接口主要是描述一些共享内存，协议数据，消息等。

Describeasfollows按照以下格式描述：

Identification标识：

Type类型：

Purpose目的：

Functions功能列表：

2Process2Description进程2描述

2.3

Level2DesignDescription（Optional）第二层设计描述（可选）

EachentitythatisdefinedinL1andidentifiedforfurtherdescriptionshallbedescribedbyseparatesub-sectionsasmentionedbelow.L1中定义的每个实体的进一步设计在下面的章节进行描述。

Thiswillberepeatedforeachmoduleasfollows（SameasLevel1）.ThedetailedsuggestionsarealsothesameasLevel1.

对每个模块重复使用下述的格式（和一层设计一样）。

具体的编写建议参见第一层设计

2.3.1Modulename

（1）模块1名称

2.3.1.1DecompositionDescription分解描述

1Module/SubsystemDecomposition模块/子系统分解

1）Module/Subsystem1Description模块/子系统1描述

2）Module/Subsystem2Descripti