华为软件概要设计模板.docx
《华为软件概要设计模板.docx》由会员分享,可在线阅读,更多相关《华为软件概要设计模板.docx(17页珍藏版)》请在冰豆网上搜索。
华为软件概要设计模板
产品名称Productname
密级Confidentialitylevel
Productversion
产品版本
Total16pages共16页
XXHighLevelDesignSpecification
XX概要设计说明书
Preparedby
Name+IDDateyyyy-mm-dd
日期+姓名工号拟制
yyyy-mm-ddReviewedbyDate
评审人日期yyyy-mm-dd
DateApprovedby
批准日期
XXXXCo.,Ltd.
XXXX有限公司
XXHighLevelDesignSpecificationPleaseinputconfidentialitylevel
请输入密级XX概要设计说明书
RevisionRecord修订记录
Date日期
Revision
Version修订版本
CRID
/
Defect
ID
CR号
Sec
No.
修改
早节
ChangeDescription修改描述
Author作
者
Page2,Total16第2页,共16页
XXHighLevelDesignSpecificationPleaseinputconfidentialitylevel
请输入密级XX概要设计说明书
Catalog目录
1Introduction简
介6
1.1Purpose目的
6
Scope1.2范围
6
Name软件名称61.2.1
1.2.26Functions软件功能
1.2.3Applications软件应用
62HighLevelDesign概要设
计6
2.1Level0DesignDescription第零层设计描述6
SoftwareSystemContextDefinition软件系统上下文定义62.1.1
2.1.27DesignConsiderations(Optional)设计思路(可选)
2.2Level1DesignDescription第一层设计描述8
DecompositionDescription分解描述82.2.1
2.2.2DependencyDescription依赖性描述
92.2.310InterfaceDescription接口描述
2.3Level2DesignDescription(Optional)第二层设计描述(可选)12
Modulename
(1)模块1名称122.3.1
2.3.213Modulename
(2)模块2名称
2.4Co“figurationandControl(Optional)配置和控制(可选)14
Startup启动142.4.1
2.4.2Closing关闭
142.4.314CreatingMIBTableItemMIB表项的创
建2.4.4DeletingMIBTableItemMIB表项的删
除.14
2.4.54表项的更改1ModifyingMIBTableItem
MIB2.5Database(Optional)数据库(可选)14
Entity,Attributesandtheirrelationships实体、属性及它们之间的关系142.5.1
2.5.2实体关系图.14E-Rdiagram
Page3,Total16第3页,共16页
XXHighLevelDesignSpecificationPleaseinputconfidentialitylevel
请输入密级概要设计说明书XX
TableList表目录
错误!
未定义书
错误!
未定义书
错误!
未定义书
错误!
未定义书
Table1**表
签。
表1**表
签。
FigureList图目录
Figure1**图
签。
图1**图
签。
Page4,Total16第4页,共16页
XXHighLevelDesignSpecificationPleaseinputconfidentialitylevel
请输入密级概要设计说明书XX
XXHighLevelDesignSpecification
XX概要设计说明书
Keywords关键词:
Abstract摘要:
对本文所用缩略语进行说明,要求提供每个缩略语的英文vabbreviations缩略语清单:
Listof
全名和中文解释。
Describeabbreviationsinthisdocument,fullspellingofthe
abbreviationandChineseexplanationshouldbeprovided.〉
Abbreviations缩略语
Fullspelling央文全名
Chineseexplanation中文解释
Page5,Total16第5页,共16页
XXHighLevelDesignSpecificationPleaseinputconfidentialitylevel
请输入密级XX概要设计说明书
1Introduction简介
Purpose目的1.1
Thissectionshouldstatethepurposeofthedocument.Itcouldalsospecifytheintendedaudienee.
这部分要描述文档的目的。
应该指明读者。
1.2Scope范围
1.2.1Name软件名称
Identifythesoftwarebyname
对软件命名
1.2.2Functions软件功能
Explainwhatthesoftwareproduct(s)willandwillnotdo(eitherdirectlyorbyreferencetoanothersoftwaredocument).
解释软件产品将完成或不完成的功能(可以直接描述也可以参考相关文档)
1.2.3Applications软件应用
Describetheapplicationoftheproduct(eitherdirectlyorbyreferencetoanothersoftwaredocument)
描述软件的应用(可直接描述也可以参考其它软件文档)
2HighLevelDesign概要设计
Level0DesignDescription2.1第零层设计描述
2.1.1SoftwareSystemContextDefinition软件系统上下文定义
Describesthenetworkorganizingmodeofthesoftwaresysteminactualenvironment(usuallyindrawings).
Describeshowthesoftwaresystemformsafunctionalentitywithotherexternalentities(usuallyindrawings).
首先描述本软件系统在实际环境的组网方式(一般用图描述)
描述系统如何与外部实体一道组成功能实体(一般用图描述)
Page6,Total16第6页,共16页
XXHighLevelDesignSpecificationPleaseinputconfidentialitylevel
请输入密级XX概要设计说明书
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,youcanmakeindexestorefertotherelativedocumentsthatdescribethesoftware
design.Forexample,anindexcanbemadefortheprogrammingguidaneeoftheOS.
所有系统外围实体在设计规格流程中有定义,这些实体与软件系统发生交互作用或以某种方)(式
影响软件系统,比如,操作系统,驱动程序,硬件,中断,其它软件系统等.
外围实体和本系统相互作用的性质比如,消息,库调用和类型比如,服务,通信服务,OS()(系
统工具等。
描述外部实体的特性时要注意该描述一定要有助本软件的设计和描述。
为了本文档)
内容的完整性,可以采用对于描述相关设计实体文档索引的方式:
如对于操作系统编程手册的索
引
2.1.2DesignConsiderations(Optional)设计思路(可选)
2.121DesignMethodology设计方法
描述本软件Describedesignmethodologythatshallbeusedinthesoftwaresystemdesign.系
统所采取的设计方法。
2.1.2.2DesignAlternatives设计可选方案
Analysisseveralalternativesofsystemdesignscheme,andspecifytheschemethatshall对本软件系统的几种设计方案进行分析、比较,并确定所采用的方案beused.
2.1.2.3DesignConstraints设计约束1Standardscomplianee遵循标准
描述本软件所遵循的标准、规范Describestandardsthatsoftwaresystemshallcomplywith.
Page7,Total16第7页,共16页
XXHighLevelDesignSpecificationPleaseinputconfidentialitylevel
请输入密级XX概要设计说明书
2HardwareLimitations硬件限制
描述本软件系统实现的硬件限制Describehardwarelimitationsofthesoftwaresystem.3
TechnologyLimitations技术限制
描述本软件的技术限制Describetechnologylimitationsofthesoftwaresystem.2.124Other
DesignConsiderations其它
描述其它有关的设计考虑Describeotherdesignconsiderationsofthesoftwaresystem.2.2
Level1DesignDescription第一层设计描述
这里要描述软件系统的总体结Architectureofthesoftwaresystemshallbedescribedhere.
构。
Structurechart,Hierarchicaldecompositiondiagram,naturallanguagecanbeusedto
总体结构描述可以使用结构图,层次分解图,自然语言。
representthearchitecture.2.2.1
DecompositionDescription分解描述
2.2.1.1Module/SubsystemDecomposition模块/子系统分解
本节描述系统中的子系统和模Thissectiondescribessubsystems,moduleinthesystem..块。
1Module/Subsystem1Description模块/子系统1描述
按照以下格式描述:
Describeasfollows
标识:
Identification
类型:
Type
目的:
Purpose功能列表:
Functions
要实现的需求ID:
RequirementIDstoimplement
子模块:
Ifthismodulewillbefurtherdecomposedintosubmodules,listallSubmodules:
如果本模块还要继续划分,列出下属子模块submoduleshere.
2Module/Subsystem2Description模块/子系统2描述
2.2.1.2ConcurrentProcessDecomposition并发进程处理分解
本节描述系统中的并发进程。
Thissectiondescribesconcurrentprocessesinthesystem..
对于外部实体,从Incaseofexternalentities,Subordinatesattributeneednotbedescribed.
属属性不必描述。
Page8,Total16第8页,共16页
XXHighLevelDesignSpecificationPleaseinputconfidentialitylevel
请输入密级XX概要设计说明书
1Process1Description进程1描述按照以下格式描述:
Describeasfollows
标识:
Identification
类型:
Type
目的:
Purpose功能列表:
Functions
Thispartdescribesthefunctionstobeperformedintheprocess.Ifthefunctionhasbeendescribedinmoduledecompositionbefore,descriptionshouldbemadeonwhatfunctionsofthemodulesareimplementedinthisprocess.
描述本进程中要完成的功能,如功能已经在前面的模块分解中有描述,则重点描述本进程完成了
哪些模块的哪些功能。
2Process2Description进程2描述
2.2.1.3DataDecomposition数据分解
本节描述系统中的数据结构。
Thissectiondescribesdatastoresinthesystem..外部数据实
体不必描述。
Externaldataentitiesshallnotbedescribed.Describestheglobaldatastructure
ofthesystem,including:
thedatadirectlyaccessedby
decomposedmodules,andthedatastructureusedininterfaceofdecomposedmodules.
When
describingthedata,makesurethedataistheglobaldataofthelevel.
本章节描述本系统中用到的全局数据结构,其中至少包括:
各分解模块直接访问的数据,被各分解模块用来在接口中使用的结构。
描述数据时要注意该数据是否真正为本级模块分解的公用数据。
1DataEntity1Description数据实体1描述
按照以下格式描述:
Describeasfollows
标识:
Identification
类型:
Type
目的:
Purpose2DataEntity2Description数据实体2描述
2.2.2DependencyDescription依赖性描述
Thissectiondescribesrelationshipsamongthedesignentitiessuchassubsystems,data
本节描述系统中的子系统,数据结构,模块,进程等设计实stores,modules,andprocessesetc..体间的关系。
Page9,Total16第9页,共16页
XXHighLevelDesignSpecificationPleaseinputconfidentialitylevel
请输入密级XX概要设计说明书
Structurecharts,transactiondiagrams,MSC,ERdiagramcanbeusedtorepresent
依赖关系描述可以使用结构图(交互)事务图,消息序列图图。
,ERdependences.2.2.2.1
RunningDesign运行设计
Thissectiondescribeshowthemodulesandtheprocessesofthisdesignlevelcooperatetoperformthefunctionalrequirementsofthesystem.MSC,transactiondiagrams,Structurecharts
canbeusedtorepresenttherunningprocedure.Note:
AllthefunctionalrequirementsinSRSshouldbecoveredinthedescription.ForLevel2,Functionspecificationofthemoduletobedecomposedshouldbecovered.
本章节描述本层设计的各个模块和进程是如何配合完成系统的功能需求可以用消息序列图,
交互事务图结构图等进行描述可以按照处理过程进行分节描述要注意的是描述的内容应该涵
(,),
盖所有文档的功能需求对于二级设计来讲就是要涵盖分解对象模块的功能规格,SRS,
222.2DataDependencies数据依赖关系
。
Thissectiondescribesrelationshipsamongdatastores本节描述数据结构间的关系。
ERdiagramcanbeusedtorepresentdependences.
依赖关系描述可以使用图。
ER2.2.3IntefaceDescription接口描述
Thissectiondescribesinterfacesofthedesignentities(suchassubsystem,module,
。
process)thatmakeupthesystem本节描述软件系统中设计实体如子系统,模块,进程)的
接口.
(Interfacefiles,parametertablescanbeusedtodescribeInterface.
接口描述可以使用接口文件,参数表。
Incaseofexternalentities,onlytheinterfacesrelevanttothesoftwarebeingdescribedneedbedescribed.
对于外部实体只有同被描述软件相关的接口才需描述。
2.2.3.1Module/SubsystemInterfaces模块/子系统接口
。
本节描述模块子系统/ThissectiondescribesinterfacesofModule/SubsystemInterfaces