XX软件系统设计说明书

项目名称ProjectName密级ConfidentialityLevel仅供收件方查阅项目编号ProjectID版本Version文档编号DocumentCodeProjectID_SD_001XXSoftwareSystemDesignSpecification

XX软件系统设计说明书Preparedby拟制Date日期yyyy-mm-ddReviewedby评审人Date日期yyyy-mm-ddApprovedby批准Date日期yyyy-mm-dd版权所有不得复制Copyright©BroadenGateTechnologies,Co.,Ltd..AllRightsReserved

RevisionRecord修订记录Date日期RevisionVersion修订版本CRID/DefectIDCR/Defect号SecNo.修改章节ChangeDescription修改描述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第0层设计描述 72.1.1 SoftwareSystemContextDefinition软件系统上下文定义： 72.1.2 DesignConsiderations(Optional)设计思路(可选) 82.2 Level1DesignDescription第一层设计描述 82.2.1 DecompositionDescription分解描述 92.2.2 DependencyDescription依赖性描述 102.2.3 InterfaceDescription接口描述 112.3 Level2DesignDescription（Optional）第二层设计描述（可选） 122.3.1 Modulename(1)模块1名称 132.3.2 Modulename(2)模块2名称 142.4 ConfigurationandControl（Optional）配置和控制（可选） 142.4.1 Startup启动 142.4.2 Closing关闭 142.4.3 CreatingMIBTableItemMIB表项的创建 142.4.4 DeletingMIBTableItemMIB表项的删除 142.4.5 ModifyingMIBTableItemMIB表项的更改 142.5 Database（Optional）数据库（可选） 152.5.1 Entity,Attributesandtheirrelationships实体、属性及它们之间的关系 152.5.2 E-Rdiagram实体关系图 153 DetailedDesign详细设计 153.1 Module1DetailDesign模块1详细设计 153.1.1 DataDescription数据描述 163.1.2 FunctionDescription函数描述 173.2 Module2DetailDesign模块2详细设计 203.3 ErrorProcess错误处理 203.3.1 SystemError系统错误 203.3.2 InterfaceError接口错误 203.3.3 ProtocolError协议错误 20

Keywords关键词：软件设计说明书Abstract摘要：本文档表述了XX软件的具体设计Listofabbreviations缩略语清单：Abbreviations缩略语Fullspelling英文全名Chineseexplanation中文解释

Introduction简介Purpose目的Thissectionshouldstatethepurposeofthisdocument.Theintendedreadershouldalsobespecifiedhere.这部分要描述文档的目的，并指明文档的读者。Scope范围Name软件名称Identifythesoftwarebyname.对软件命名。Functions软件功能Explainwhatthesoftwareproduct(s)willandwillnotdo(eitherdirectlyorbyreferencetoanotherrelateddocument).解释软件产品将完成或不完成的功能（可以直接描述也可以参考相关文档）。Applications软件应用Describetheapplicationoftheproduct(eitherdirectlyorbyreferencetoanothersoftwaredocument)描述软件的应用（可直接描述也可以参考其他软件文档）HighLevelDesign概要设计Level0DesignDescription第0层设计描述SoftwareSystemContextDefinition软件系统上下文定义：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服务，通信服务，系统工具等)。描述外部实体的特性时要注意该描述一定要有助本软件的设计和描述。为了本文档内容的完整性，可以采用对于描述相关设计实体文档索引的方式：如对于操作系统编程手册的索引DesignConsiderations(Optional)设计思路(可选)DesignMethodology设计方法Describedesignmethodologythatshallbeusedinthesoftwaresystemdesign.描述本软件系统所采取的设计方法。DesignAlternatives设计可选方案Analysisseveralalternativesofsystemdesignscheme,andspecifytheschemethatshallbeused.对本软件系统的几种设计方案进行分析、比较，并确定所采用的方案DesignConstraints设计约束Standardscompliance遵循标准Describestandardsthatsoftwaresystemshallcomplywith.描述本软件所遵循的标准、规范HardwareLimitations硬件限制Describehardwarelimitationsofthesoftwaresystem.描述本软件系统实现的硬件限制TechnologyLimitations技术限制Describetechnologylimitationsofthesoftwaresystem.描述本软件的技术限制OtherDesignConsiderations其他Describeotherdesignconsiderationsofthesoftwaresystem.描述其他有关的设计考虑Level1DesignDescription第一层设计描述Architectureofthesoftwaresystemshallbedescribedhere.这里要描述软件系统的总体结构。Structurechart,Hierarchicaldecompositiondiagram,naturallanguagecanbeusedtorepresentthearchitecture.总体结构描述可以使用结构图，层次分解图，自然语言。DecompositionDescription分解描述Module/SubsystemDecomposition模块/子系统分解Thissectiondescribessubsystems,moduleinthesystem..本节描述系统中的子系统和模块。Module/Subsystem1Description模块/子系统1描述Describeasfollows按照以下格式描述：Identification标识：Type类型：Purpose目的：Functions功能列表：Submodules:子模块：Ifthismodulewillbefurtherdecomposedintosubmodules,listallsubmoduleshere.如果本模块还要继续划分，列出下属子模块ConcurrentProcessDecomposition并发进程处理分解Thissectiondescribesconcurrentprocessesinthesystem..本节描述系统中的并发进程。Incaseofexternalentities,Subordinatesattributeneednotbedescribed.对于外部实体，从属属性不必描述。Process1Description进程1描述Describeasfollows按照以下格式描述：Identification标识：Type类型：Purpose目的：Functions功能列表：Thispartdescribesthefunctionstobeperformedintheprocess.Ifthefunctionhasbeendescribedinmoduledecompositionbefore,descriptionshouldbemadeonwhatfunctionsofthemodulesareimplementedinthisprocess.描述本进程中要完成的功能，如功能已经在前面的模块分解中有描述，则重点描述本进程完成了哪些模块的哪些功能。DataDecomposition数据分解Thissectiondescribesdatastoresinthesystem..本节描述系统中的数据结构。Externaldataentitiesshallnotbedescribed.外部数据实体不必描述。Describestheglobaldatastructureofthesystem,including:thedatadirectlyaccessedbydecomposedmodules,andthedatastructureusedininterfaceofdecomposedmodules.Whendescribingthedata,makesurethedataistheglobaldataofthelevel.本章节描述本系统中用到的全局数据结构，其中至少包括：各分解模块直接访问的数据，被各分解模块用来在接口中使用的结构。描述数据时要注意该数据是否真正为本级模块分解的公用数据。DataEntity1Description数据实体1描述Describeasfollows按照以下格式描述：Identification标识：Type类型：Purpose目的：DependencyDescription依赖性描述Thissectiondescribesrelationshipsamongthedesignentitiessuchassubsystems,datastores,modules,andprocessesetc..本节描述系统中的子系统，数据结构，模块，进程等设计实体间的关系。Structurecharts,transactiondiagrams,MSC,ERdiagramcanbeusedtorepresentdependences.依赖关系描述可以使用结构图（交互）事务图，消息序列图,ER图。RunningDesign运行设计Thissectiondescribeshowthemodulesandtheprocessesofthisdesignlevelcooperatetoperformthefunctionalrequirementsofthesystem.MSC,transactiondiagrams,Structurechartscanbeusedtorepresenttherunningprocedure.Note:AllthefunctionalrequirementsinSRSshouldbecoveredinthedescription.ForLevel2,Functionspecificationofthemoduletobedecomposedshouldbecovered.本章节描述本层设计的各个模块和进程是如何配合完成系统的功能需求.可以用消息序列图,(交互)事务图,结构图等进行描述,可以按照处理过程进行分节描述,要注意的是描述的内容应该涵盖所有SRS文档的功能需求,对于二级设计来讲,就是要涵盖分解对象模块的功能规格DataDependencies数据依赖关系Thissectiondescribesrelationshipsamongdatastores。本节描述数据结构间的关系。ERdiagramcanbeusedtorepresentdependences.依赖关系描述可以使用ER图。InterfaceDescription接口描述Thissectiondescribesinterfacesofthedesignentities(suchassubsystem,module,process)thatmakeupthesystem。本节描述软件系统中设计实体(如子系统，模块，进程）的接口.Interfacefiles,parametertablescanbeusedtodescribeInterface.接口描述可以使用接口文件，参数表。Incaseofexternalentities,onlytheinterfacesrelevanttothesoftwarebeingdescribedneedbedescribed.对于外部实体只有同被描述软件相关的接口才需描述。Module/SubsystemInterfaces模块/子系统接口ThissectiondescribesinterfacesofModule/SubsystemInterfaces。本节描述模块/子系统的接口。InterfacesProvidedbyModule/Subsystem1模块/子系统1提供的接口Forinterfacefunction,followingformatshouldbeused:Interface1:Format:Input:Output:Return:DescribesthereturnvalueofthefunctionDescription:Describestheobjectiveoftheinterface.对于接口函数，可以采用以下形式描述：接口1：形式：输入：输出：返回：描述返回什么。描述：总体描述该接口实现的目的。ProcessInterfaces进程接口Thissectiondescribesinterfacesofprocess。本节描述进程的接口。Process1Description进程1描述Theinterfacesbetweentheprocessesdescribethesharedmemory,protocoldataandmessages,etc.进程间的接口主要是描述一些共享内存，协议数据，消息等。Describeasfollows按照以下格式描述：Identification标识：Type类型：Purpose目的：Functions功能列表：Level2DesignDescription（Optional）第二层设计描述（可选）EachentitythatisdefinedinL1andidentifiedforfurtherdescriptionshallbedescribedbyseparatesub-sectionsasmentionedbelow.L1中定义的每个实体的进一步设计在下面的章节进行描述。Thiswillberepeatedforeachmoduleasfollows(SameasLevel1).ThedetailedsuggestionsarealsothesameasLevel1.对每个模块重复使用下述的格式(和一层设计一样)。具体的编写建议参见第一层设计Modulename(1)模块1名称DecompositionDescription分解描述Module/SubsystemDecomposition模块/子系统分解Module/Subsystem1Description模块/子系统1描述Module/Subsystem2Description模块/子系统2描述******ConcurrentProcessDecomposition并发进程处理分解Process1Description进程1描述Process2Description进程2描述******DataDecomposition数据分解DataEntity1Description数据实体1描述DataEntity2Description数据实体2描述******DependencyDescription依赖性描述RunningDesign运行设计DataDependencies数据依赖关系******InterfaceDescription接口描述Module/SubsystemInterfaces模块/子系统接口InterfacesProvidedbyModule/Subsystem1模块/子系统1提供的接口InterfacesProvidedbyModule/Subsystem2模块/子系统2提供的接口******ProcessInterfaces进程接口Process1Description进程1描述Process1Description进程1描述******Modulename(2)模块2名称******ConfigurationandControl（Optional）配置和控制（可选）Startup启动Describesthestepstostartupamodule描述启动一个模块的步骤Closing关闭Describesthestepstocloseamodule描述关闭一个模块的步骤CreatingMIBTableItemMIB表项的创建Stepstocreateanewtableitem.Thetitleofthissectioncanbemodified.创建新表项的动作步骤。该节的标题可以适当更改DeletingMIBTableItemMIB表项的删除Stepstodeleteatableitem.Thetitleofthissectioncanbemodified.删除表项的动作步骤.该节的标题可以适当更改ModifyingMIBTableItemMIB表项的更改Stepstomodifyatableitem.Thetitleofthissectioncanbemodified.修改表项的动作步骤.该节的标题可以适当更改。Database（Optional）数据库（可选）Entity,Attributesandtheirrelationships实体、属性及它们之间的关系Thissectioncouldlistalltheentitiessuchasdatastores,averbosedescriptionofwhatthatentitypertainstoandlistofallitsattributes.Foreachoftheattributes,itsdatabase,thedatasize,specificconstraintsandaverbosedescriptionofthatattributeshouldbespecified.Allspecificconstraintsforthatentityanditsrelationshipwithotherentitiesshouldalsobenoted.本节列出所有的数据存储类的实体，详细描述实体的内容和并列出全部属性。对每个属性，详细描述其数据库、数据大小、特定约束。实体的所有约束及实体间的关系也要注明。E-Rdiagram实体关系图ThissectionshoulddisplaytheE-Rdiagramforalltheentitieslistedabove.本节描述关于上节提到的所有实体的E-R图DetailedDesign详细设计ThissectionshouldfocusonthedescriptionofthedetaileddesignofthesoftwareentitiesthatareapartofthesoftwarebeingdescribedbytheHLDSpecification。.对于在概要设计说明书中给出的软件实体，本节集中描述它们的详细描述部分。Module1DetailDesign模块1详细设计Describedatathatdefinedorusedinthemodule,including:Simpledatai.e.globalvariable,constantormacrowithinthemodule;Complexdatai.e.Structureorunion描述模块中定义和使用的数据，包括：简单数据，如模块级的全局变量、常量、宏；复合数据，如模块内部的结构、联合...；DataDescription数据描述Describesimplevariables,constantormacroofthemoduleinsub-section1;Describecomplexdatafromsub-section2,suchasstructure,union;在1中描述本模块中的简单变量、常量、宏；从第2部分起描述本模块中的复合数据，如结构、联合等；SimpleDataDescription简单数据描述；describesimplevariables、constantormacrousedordefinedinthismodule;描述在本模块中定义和使用的简单变量、常量、宏；Describessimplevariables,constantsusedordefinedinthismodule;Thedescriptionofsimpledatashouldfollowtheformatbelow:FunctionDescription:DescribingtheusageofthedataDataDefinition:Definingthedata按照下列格式进行简单数据的描述功能描述：描述该数据的用途数据定义：定义该数据Structure1结构1DefineanddescribetheDatastructure(includeunion)定义和说明该数据结构(包括联合);Thedescriptionofdatastructureshouldfollowtheformatbelow:DataStructureDescription:DescribingtheusageofthedatastructureDataStructureDefinition:DefiningthedatastructurewiththeactualprogramminglanguageDataItemsDescription:DataTypeDataItemDefinitionDataItemDescription按照下列格式进行数据结构的描述数据结构描述：描述该数据结构的用途数据结构定义：用实际的编程语言定义该数据结构数据项描述：数据类型数据项定义数据项描述Structure2结构2FunctionDescription函数描述Thissectionshouldfollowtheformatbelow:Identification:TitleofthemoduleType:Typeofthemodule,forexample,themoduleinLevel2Design,theprocessinLevel1Design,etc.FunctionDescription:Describingthefunctionsofthemoduleinbrief,whichshouldbeconsistentwiththerelatedsectionoftheHLDdocuments.FunctionInvokingRelation:UsingtheHierarchyChartorStructureCharttodescribeit,forexample:本节应按照下列格式进行描述：标识：模块名称类型：模块类型，如，2级设计中的模块，1级设计中的进程功能概述：简要描述本模块功能，要和概要设计文档中相关模块分解的描述一致。函数调用关系:用层次图或结构图的方式描述函数调用关系，如：Module1StructureChart模块1结构图Function1函数1Descriptthefunctionasfollows;Function://nameoffunctionDescription://functionalityofthefunctionCalls://functionlistswhichcalledbythisfunctionDataAccessed://globalvariablesordatabasetablest