华为软件概要设计模板

1、产品名称Productname密级Confidentialitylevel产品版本ProductversionTotal16pages共16页XXHighLevelDesignSpecificationXX概要设计说明书PreparedbyName+IDDateyyyy-mm-dd拟制姓名+工号日期ReviewedbyDateyyyy-mm-dd评审人日期ApprovedbyDateyyyy-mm-dd批准日期XXXXCo.,Ltd.XXXX有限公司RevisionRecord修订记录Date日期RevisionVersion修订版本CRID/DefectIDCR号SecNo.修改早下Chan

2、geDescription修改描述Author作者Catalog目录1 Introduction简介61.1 Purpose目的61.2 Scope范围61.2.1 Name软件名称61.2.2 Functions软件功能61.2.3 Applications软件应用62 HighLevelDesign概要设计62.1 Level0DesignDescription第零层设计描述62.1.1 SoftwareSystemContextDefinition软件系统上下文定义62.1.2 DesignConsiderations(Optional)设计思路(可选)72.2 Level1Design

3、Description第层设计描述82.2.1 DecompositionDescription分解描述82.2.2 DependencyDescription依赖性描述92.2.3 InterfaceDescription接口描述102.3 Level2DesignDescription(Optional)第二层设计描述(可选)122.3.1 Modulename(1)模块1名称122.3.2 Modulename(2)模块2名称132.4 ConfigurationandControl(Optional)配置和控制(可选)142.4.1 Startup启动142.4.2 Closing关闭

4、142.4.3 CreatingMIBTableItemMIB表项的创建142.4.4 DeletingMIBTableItemMIB表项的删除142.4.5 ModifyingMIBTableItemMIB表项的更改142.5 Database(Optional)数据库(可选)142.5.1 Entity,Attributesandtheirrelationships实体、属性及它们之间的关系142.5.2 E-Rdiagram实体关系图14TableList表目录Tablel*表错误!未定义书签。表1*表错误!未定义书签。FigureList图目录Figure1*图错误!未定义书签。图1*

5、图错误!未定义书签。XXHighLevelDesignSpecificationXX概要设计说明书Keywords关键词：Abstract摘要：Listofabbreviations缩略语清单：对本文所用缩略语进行说明，要求提供每个缩略语的英文全名和中文解释。Describeabbreviationsinthisdocument,fullspellingoftheabbreviationandChineseexplanationshouldbeprovided.Abbreviations缩略语Fullspelling央义全名Chineseexplanation中文解释1 Introductio

6、n简介1 Purpose目的Thissectionshouldstatethepurposeofthedocument.Itcouldalsospecifytheintendedaudience.这部分要描述文档的目的。应该指明读者。1 Scope范围1 Name软件名称Identifythesoftwarebyname对软件命名1 Functions软件功能Explainwhatthesoftwareproduct(s)willandwillnotdo(eitherdirectlyorbyreferencetoanothersoftwaredocument).解释软件产品将完成或不完成的功能

7、(可以直接描述也可以参考相关文档)1 Applications软件应用Describetheapplicationoftheproduct(eitherdirectlyorbyreferencetoanothersoftwaredocument)描述软件的应用(可直接描述也可以参考其它软件文档)2 HighLevelDesign概要设计2 Level0DesignDescription第零层设计描述2 SoftwareSystemContextDefinition软件系统上下文定义Describesthenetworkorganizingmodeofthesoftwaresysteminact

8、ualenvironment(usuallyindrawings).Describeshowthesoftwaresystemformsafunctionalentitywithotherexternalentities(usuallyindrawings).首先描述本软件系统在实际环境的组网方式(一般用图描述)描述系统如何与外部实体一道组成功能实体(一般用图描述)Thissectiondescribesrelationshipsbetweenthesoftwaresystemtobedevelopedandexternalentities.ArchitectureDiagram,Toplev

9、elDFD(Data-Flow-Diagram)ortransactiondiagramscanbeusedtodescribearchitectureandinteraction.本节还要描述待开发软件系统与外部实体的关系.，可以使用系统架构图、顶层数据流图、事务图等来描述系统结构和交互关系。Allexternalentitiesofthesoftwaresystem(definedinProcedureofDesignSpecification)thatinteractwiththesoftwaresystem,oraffectthesoftwaresysteminacertainmode

10、,forexample,OS,driver,hardware,interruptorothersoftwaresystems.Theproperty(suchasmessage,libraryinvoking)andtype(suchasOSservice,communicationservice,systemtools,etc.)oftheinteractionbetweenexternalentitiesandthissystem.Onlythecontentsthatarehelpfulinthesoftwaredesignshouldbeincludedwhiledescribingt

11、hefeaturesofanexternalentity.Insteadofacompletedescriptioninthisspecification,youcanmakeindexestorefertotherelativedocumentsthatdescribethesoftwaredesign.Forexample,anindexcanbemadefortheprogrammingguidanceoftheOS.所有系统外围实体(在设计规格流程中有定义)，这些实体与软件系统发生交互作用或以某种方式影响软件系统，比如，操作系统，驱动程序，硬件，中断，其它软件系统等.外围实体和本系统相

12、互作用的性质(比如，消息，库调用)和类型(比如，OS服务，通信服务，系统工具等)。描述外部实体的特性时要注意该描述一定要有助本软件的设计和描述。为了本文档内容的完整性，可以采用对于描述相关设计实体文档索引的方式：如对于操作系统编程手册的索引2 DesignConsiderations(Optional)设计思路(可选)2 DesignMethodology设计方法Describedesignmethodologythatshallbeusedinthesoftwaresystemdesign.描述本软件系统所采取的设计方法。2 DesignAlternatives设计可选方案Analysiss

13、everalalternativesofsystemdesignscheme,andspecifytheschemethatshallbeused.对本软件系统的几种设计方案进行分析、比较，并确定所采用的方案2 DesignConstraints设计约束1) Standardscompliance遵循标准Describestandardsthatsoftwaresystemshallcomplywith.描述本软件所遵循的标准、规范2) HardwareLimitations硬件限制Describehardwarelimitationsofthesoftwaresystem.描述本软件系统实现

14、的硬件限制3) TechnologyLimitations技术限制Describetechnologylimitationsofthesoftwaresystem.描述本软件的技术限制2 OtherDesignConsiderations其它Describeotherdesignconsiderationsofthesoftwaresystem.描述其它有关的设计考虑2 Level1DesignDescription第一层设计描述Architectureofthesoftwaresystemshallbedescribedhere.这里要描述软件系统的总体结构。Structurechart,H

15、ierarchicaldecompositiondiagram,naturallanguagecanbeusedtorepresentthearchitecture.总体结构描述可以使用结构图，层次分解图，自然语言。2 DecompositionDescription分解描述2 Module/SubsystemDecomposition模块/子系统分解Thissectiondescribessubsystems,moduleinthesystem.本节描述系统中的子系统和模块。1) Module/Subsystem1Description模块/子系统1描述Describeasfollows按照

16、以下格式描述：Identification标识：Type类型：Purpose目的：Functions功能列表：RequirementIDstoimplement要实现的需求ID:Submodules:子模块：Ifthismodulewillbefurtherdecomposedintosubmodules,listallsubmoduleshere.如果本模块还要继续划分，列出下属子模块2) Module/Subsystem2Description模块/子系统2描述2 ConcurrentProcessDecomposition并发进程处理分解Thissectiondescribesconcu

17、rrentprocessesinthesystem.本节描述系统中的并发进程。Incaseofexternalentities,Subordinatesattributeneednotbedescribed.对于外部实体，从属属性不必描述。2 Process1Description进程1描述Describeasfollows按照以下格式描述：Identification标识：Type类型：Purpose目的：Functions功能列表：Thispartdescribesthefunctionstobeperformedintheprocess.Ifthefunctionhasbeendescr

18、ibedinmoduledecompositionbefore,descriptionshouldbemadeonwhatfunctionsofthemodulesareimplementedinthisprocess.描述本进程中要完成的功能，如功能已经在前面的模块分解中有描述，则重点描述本进程完成了哪些模块的哪些功能。3 Process2Description进程2描述2 DataDecomposition数据分解Thissectiondescribesdatastoresinthesystem.本节描述系统中的数据结构。Externaldataentitiesshallnotbedesc

19、ribed.外部数据实体不必描述。Describestheglobaldatastructureofthesystem,including:thedatadirectlyaccessedbydecomposedmodules,andthedatastructureusedininterfaceofdecomposedmodules.Whendescribingthedata,makesurethedataistheglobaldataofthelevel.本章节描述本系统中用到的全局数据结构，其中至少包括：各分解模块直接访问的数据，被各分解模块用来在接口中使用的结构。描述数据时要注意该数据是否

20、真正为本级模块分解的公用数据。4.4 DataEntity1Description数据实体1描述Describeasfollows按照以下格式描述：Identification标识：Type类型：Purpose目的：5.5 DataEntity2Description数据实体2描述2 DependencyDescription依赖性描述Thissectiondescribesrelationshipsamongthedesignentitiessuchassubsystems,datastores,modules,andprocessesetc.本节描述系统中的子系统，数据结构，模块，进程等设

21、计实体间的关系。Structurecharts,transactiondiagrams,MSC,ERdiagramcanbeusedtorepresentdependences.依赖关系描述可以使用结构图（交互）事务图，消息序列图，ER图。2 RunningDesign运行设计Thissectiondescribeshowthemodulesandtheprocessesofthisdesignlevelcooperatetoperformthefunctionalrequirementsofthesystem.MSC,transactiondiagrams,Structurechartsca

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

23、功能规格2 DataDependencies数据依赖关系Thissectiondescribesrelationshipsamongdatastores。本节描述数据结构间的关系。ERdiagramcanbeusedtorepresentdependences.依赖关系描述可以使用ER图。2 InterfaceDescription接口描述Thissectiondescribesinterfacesofthedesignentities（suchassubsystem,module,process）thatmakeupthesystem。本节描述软件系统中设计实体（如子系统，模块，进程）的接口

24、.Interfacefiles,parametertablescanbeusedtodescribeInterface.接口描述可以使用接口文件，参数表。Incaseofexternalentities,onlytheinterfacesrelevanttothesoftwarebeingdescribedneedbedescribed.对于外部实体只有同被描述软件相关的接口才需描述。2 Module/SubsystemInterfaces模块/子系统接口ThissectiondescribesinterfacesofModule/SubsystemInterfaces。本节描述模块/子系统的

25、接口。1.1.1 InterfacesProvidedbyModule/Subsystem1模块/子系统1提供的接口Forinterfacefunction,followingformatshouldbeused:Interface1:Format:Input:Output:Return:DescribesthereturnvalueofthefunctionDescription:Describestheobjectiveoftheinterface.对于接口函数，可以采用以下形式描述：接口1:形式：输入：输出：返回：描述返回什么。描述：总体描述该接口实现的目的。2.2.2 Interfac

26、esProvidedbyModule/Subsystem2模块/子系统2提供的接口2 ProcessInterfaces进程接口Thissectiondescribesinterfacesofprocess。本节描述进程的接口。1 Process1Description进程1描述Theinterfacesbetweentheprocessesdescribethesharedmemory,protocoldataandmessages,etc.进程间的接口主要是描述一些共享内存，协议数据，消息等。Describeasfollows按照以下格式描述：Identification标识：Type类型

27、：Purpose目的：Functions功能列表：2 Process2Description进程2描述2 Level2DesignDescription(Optional)第二层设计描述(可选)EachentitythatisdefinedinL1andidentifiedforfurtherdescriptionshallbedescribedbyseparatesub-sectionsasmentionedbelow.L1中定义的每个实体的进一步设计在下面的章节进行描述。Thiswillberepeatedforeachmoduleasfollows(SameasLevel1).Thede

28、tailedsuggestionsarealsothesameasLevel1.对每个模块重复使用下述的格式(和一层设计一样)。具体的编写建议参见第一层设计2 Modulename(1)模块1名称2 DecompositionDescription分解描述Module/SubsystemDecomposition模块/子系统分解Module/Subsystem1Description模块/子系统1描述Module/Subsystem2Description模块/子系统2描述*ConcurrentProcessDecomposition并发进程处理分解Process1Description进程1

29、描述Process2Description进程2描述*2 DataEntityDescription数据实体描述Describeasfollows按照以下格式描述模块内部使用的多个数据实体：Identification标识：Type&structure(ifapplicable)类型及组成结构(必要的话)：Purpose目的：2 DependencyDescription依赖性描述RunningDesign运行设计DataDependencies数据依赖关系*2 InterfaceDescription接口描述Module/SubsystemInterfaces模块/子系统接口0000

30、00000000 InterfacesProvidedbyModule/Subsystem1模块/子系统1提供的接口111111111111 InterfacesProvidedbyModule/Subsystem2模块/子系统2提供的接口*2ProcessInterfaces进程接口Process1Description进程1描述Process1Description进程1描述*2.3.2Modulename(2)模块2名称*ConfigurationandControl(Optional)配置和控制(可选)Startup启动Describesthestepstostartupamodule

31、.描述启动一个模块的步骤Closing关闭Describesthestepstocloseamodule.描述关闭一个模块的步骤CreatingMIBTableItemMIB表项的创建Stepstocreateanewtableitem.Thetitleofthissectioncanbemodified.创建新表项的动作步骤。该节的标题可以适当更改DeletingMIBTableItemMIB表项的删除Stepstodeleteatableitem.Thetitleofthissectioncanbemodified.删除表项的动作步骤.该节的标题可以适当更改ModifyingMIBTableItemMIB表项的更改Stepstomodifyatableitem.Thetitleofthissectioncanbemodified.修改表项的动作步骤.该节的标题可以适当更改。Database(Optional)数据库(可选)Entity,Attributesandtheirrelationships实体、属性及它们之间的关系Thissectioncouldlistalltheentitiessuchasdatastores,averbosedescriptionofwhatthatentitypertainstoandlistofa