華為軟件概要設(shè)計模板

產(chǎn)品名稱Productname密級Confidentialitylevel產(chǎn)品版本ProductversionTotal16pages共16頁XXHighLevelDesignSpecificationXX概要設(shè)計說明書PreparedbyName+IDDateyyyy-mm-dd擬制姓名+工號日期ReviewedbyDateyyyy-mm-dd評審人日期ApprovedbyDateyyyy-mm-dd批準(zhǔn)日期XXXXCo.,Ltd.XXXX有限公司

XXHighLevelDesignSpecificationXXXXHighLevelDesignSpecificationXX概要設(shè)計說明書Pleaseinputconfidentialitylevel請輸入密級RevisionRecord修訂記錄Date日期RevisionVersion修訂版本CRID/DefectIDCR號SecNo.修改章節(jié)ChangeDescription修改描述Author作者Page2,Total16第2頁，共16頁XXHighLevelDesignSpecification PleaseinputconfidentialitylevelXX概要設(shè)計說明書請輸入密級Catalog目錄TOC\o"1-5"\h\z1Introduction簡介 6Purpose目的 6Scope范圍 6Name軟件名稱 6Functions軟件功能 6Applications軟件應(yīng)用 62HighLevelDesign概要設(shè)計 6Level0DesignDescription 第零層設(shè)計描述 6SoftwareSystemContextDefinition軟件系統(tǒng)上下文定義 6DesignConsiderations(Optional)設(shè)計思路 (可選) 7Level1DesignDescription 第一層設(shè)計描述 8DecompositionDescription分解描述 8DependencyDescription依賴性描述 9InterfaceDescription接口描述 10Level2DesignDescription (Optional)第二層設(shè)計描述(可選) 12Modulename(1)模塊1名稱 12Modulename(2)模塊2名稱 13ConfigurationandControl(Optional)配置和控制(可選) 14Startup啟動 14Closing關(guān)閉 14CreatingMIBTableItemMIB 表項的創(chuàng)建 14DeletingMIBTableItemMIB 表項的刪除 14ModifyingMIBTableItemMIB表項的更改 14Database(Optional)數(shù)據(jù)庫(可選) 14Entity,Attributesandtheirrelationships 實體、屬性及它們之間的關(guān)系 14E-Rdiagram實體關(guān)系圖 14Page3,Total16第3頁，共16頁

XXHighLevelDesignSpecificationXXXXHighLevelDesignSpecificationXX概要設(shè)計說明書Pleaseinputconfidentialitylevel請輸入密級TableList表目錄Table1**表 ..錯誤！未定義書簽。表1**表 FigureList圖目錄..錯誤！未定義書簽。Figure1**圖 ..錯誤！未定義書簽。圖1**圖 .錯誤！未定義書簽。Page4,Total16第4頁，共16頁

XXHighLevelDesignSpecificationXXXXHighLevelDesignSpecificationXX概要設(shè)計說明書Pleaseinputconfidentialitylevel請輸入密級XXHighLevelDesignSpecificationXX概要設(shè)計說明書Keywords關(guān)鍵詞：Abstract摘要：Listofabbreviations縮略語清單：＜對本文所用縮略語進(jìn)行說明，要求提供每個縮略語的英文全名和中文解釋。Describeabbreviationsinthisdocument,fullspellingoftheabbreviationandChineseexplanationshouldbeprovided.>Abbreviations縮略語Fullspelling英文全名Chineseexplanation中文解釋Page5,Total16第5頁，共16頁

XXHighLevelDesignSpecificationXXXXHighLevelDesignSpecificationXX概要設(shè)計說明書Pleaseinputconfidentialitylevel請輸入密級Introduction簡介Purpose目的Thissectionshouldstatethepurposeofthedocument.Itcouldalsospecifytheintendedaudience.這部分要描述文檔的目的。應(yīng)該指明讀者。Scope范圍Name軟件名稱Identifythesoftwarebyname對軟件命名Functions軟件功能Explainwhatthesoftwareproduct(s)willandwillnotdo(eitherdirectlyorbyreferencetoanothersoftwaredocument).解釋軟件產(chǎn)品將完成或不完成的功能(可以直接描述也可以參考相關(guān)文檔)Applications軟件應(yīng)用Describetheapplicationoftheproduct(eitherdirectlyorbyreferencetoanothersoftwaredocument)描述軟件的應(yīng)用(可直接描述也可以參考其它軟件文檔)HighLevelDesign概要設(shè)計Level0DesignDescription第零層設(shè)計描述SoftwareSystemContextDefinition軟件系統(tǒng)上下文定義Describesthenetworkorganizingmodeofthesoftwaresysteminactualenvironment(usuallyindrawings).Describeshowthesoftwaresystemformsafunctionalentitywithotherexternalentities(usuallyindrawings).首先描述本軟件系統(tǒng)在實際環(huán)境的組網(wǎng)方式(一般用圖描述)描述系統(tǒng)如何與外部實體一道組成功能實體(一般用圖描述)Page6,Total16第6頁，共16頁

XXHighLevelDesignSpecificationXXXXHighLevelDesignSpecificationXX概要設(shè)計說明書Pleaseinputconfidentialitylevel請輸入密級Thissectiondescribesrelationshipsbetweenthesoftwaresystemtobedevelopedandexternalentities.ArchitectureDiagram,ToplevelDFD(Data-Flow-Diagram)ortransactiondiagramscanbeusedtodescribearchitectureandinteraction.本節(jié)還要描述待開發(fā)軟件系統(tǒng)與外部實體的關(guān)系.，可以使用系統(tǒng)架構(gòu)圖、頂層數(shù)據(jù)流圖、事務(wù)圖等來描述系統(tǒng)結(jié)構(gòu)和交互關(guān)系。Allexternalentitiesofthesoftwaresystem(definedinProcedureofDesignSpecification)thatinteractwiththesoftwaresystem,oraffectthesoftwaresysteminacertainmode,forexample,OS,driver,hardware,interruptorothersoftwaresystems.Theproperty(suchasmessage,libraryinvoking)andtype(suchasOSservice,communicationservice,systemtools,etc.)oftheinteractionbetweenexternalentitiesandthissystem.Onlythecontentsthatarehelpfulinthesoftwaredesignshouldbeincludedwhiledescribingthefeaturesofanexternalentity.Insteadofacompletedescriptioninthisspecification,youcanmakeindexestorefertotherelativedocumentsthatdescribethesoftwaredesign.Forexample,anindexcanbemadefortheprogrammingguidanceoftheOS.所有系統(tǒng)外圍實體(在設(shè)計規(guī)格流程中有定義)，這些實體與軟件系統(tǒng)發(fā)生交互作用或以某種方式影響軟件系統(tǒng)，比如，操作系統(tǒng)，驅(qū)動程序，硬件，中斷，其它軟件系統(tǒng)等.外圍實體和本系統(tǒng)相互作用的性質(zhì)(比如，消息，庫調(diào)用)和類型(比如，OS服務(wù)，通信服務(wù)，系統(tǒng)工具等)。描述外部實體的特性時要注意該描述一定要有助本軟件的設(shè)計和描述。 為了本文檔內(nèi)容的完整性，可以采用對于描述相關(guān)設(shè)計實體文檔索引的方式：如對于操作系統(tǒng)編程手冊的索引DesignConsiderations(Optional)設(shè)計思路(可選)DesignMethodology設(shè)計方法Describedesignmethodologythatshallbeusedinthesoftwaresystemdesign. 描述本軟件系統(tǒng)所采取的設(shè)計方法。DesignAlternatives設(shè)計可選方案Analysisseveralalternativesofsystemdesignscheme,andspecifytheschemethatshallbeused.對本軟件系統(tǒng)的幾種設(shè)計方案進(jìn)行分析、比較，并確定所采用的方案DesignConstraints設(shè)計約束1Standardscompliance遵循標(biāo)準(zhǔn)Describestandardsthatsoftwaresystemshallcomplywith. 描述本軟件所遵循的標(biāo)準(zhǔn)、規(guī)范Page7,Total16第7頁，共16頁

XXHighLevelDesignSpecificationXXXXHighLevelDesignSpecificationXX概要設(shè)計說明書Pleaseinputconfidentialitylevel請輸入密級2HardwareLimitations硬件限制Describehardwarelimitationsofthesoftwaresystem. 描述本軟件系統(tǒng)實現(xiàn)的硬件限制TechnologyLimitations技術(shù)限制Describetechnologylimitationsofthesoftwaresystem. 描述本軟件的技術(shù)限制OtherDesignConsiderations其它Describeotherdesignconsiderationsofthesoftwaresystem. 描述其它有關(guān)的設(shè)計考慮Level1DesignDescription第一層設(shè)計描述Architectureofthesoftwaresystemshallbedescribedhere. 這里要描述軟件系統(tǒng)的總體結(jié)構(gòu)。Structurechart,Hierarchicaldecompositiondiagram,naturallanguagecanbeusedtorepresentthearchitecture.總體結(jié)構(gòu)描述可以使用結(jié)構(gòu)圖，層次分解圖，自然語言。DecompositionDescription分解描述Module/SubsystemDecomposition模塊/子系統(tǒng)分解Thissectiondescribessubsystems,moduleinthesystem.. 本節(jié)描述系統(tǒng)中的子系統(tǒng)和模塊。1Module/Subsystem1Description模塊/子系統(tǒng)1描述Describeasfollows按照以下格式描述：Identification標(biāo)識：Type類型：Purpose目的：Functions功能列表：RequirementIDstoimplement要實現(xiàn)的需求ID:Submodules:子模塊：Ifthismodulewillbefurtherdecomposedintosubmodules,listallsubmoduleshere.如果本模塊還要繼續(xù)劃分，列出下屬子模塊2Module/Subsystem2Description模塊/子系統(tǒng)2描述ConcurrentProcessDecomposition并發(fā)進(jìn)程處理分解Thissectiondescribesconcurrentprocessesinthesystem.. 本節(jié)描述系統(tǒng)中的并發(fā)進(jìn)程。Incaseofexternalentities,Subordinatesattributeneednotbedescribed. 對于外部實體，從屬屬性不必描述。Page8,Total16第8頁，共16頁XXHighLevelDesignSpecification PleaseinputconfidentialitylevelXX概要設(shè)計說明書請輸入密級1Process1Description進(jìn)程1描述Describeasfollows按照以下格式描述：Identification標(biāo)識：Type類型：Purpose目的：Functions功能列表：Thispartdescribesthefunctionstobeperformedintheprocess.Ifthefunctionhasbeendescribedinmoduledecompositionbefore,descriptionshouldbemadeonwhatfunctionsofthemodulesareimplementedinthisprocess.描述本進(jìn)程中要完成的功能，如功能已經(jīng)在前面的模塊分解中有描述，則重點描述本進(jìn)程完成了哪些模塊的哪些功能。2Process2Description進(jìn)程2描述DataDecomposition數(shù)據(jù)分解Thissectiondescribesdatastoresinthesystem.. 本節(jié)描述系統(tǒng)中的數(shù)據(jù)結(jié)構(gòu)。Externaldataentitiesshallnotbedescribed.外部數(shù)據(jù)實體不必描述。Describestheglobaldatastructureofthesystem,including:thedatadirectlyaccessedbydecomposedmodules,andthedatastructureusedininterfaceofdecomposedmodules.Whendescribingthedata,makesurethedataistheglobaldataofthelevel.本章節(jié)描述本系統(tǒng)中用到的全局?jǐn)?shù)據(jù)結(jié)構(gòu)，其中至少包括：各分解模塊直接訪問的數(shù)據(jù)，被各分解模塊用來在接口中使用的結(jié)構(gòu)。描述數(shù)據(jù)時要注意該數(shù)據(jù)是否真正為本級模塊分解的公用數(shù)據(jù)。1DataEntity1Description數(shù)據(jù)實體1描述Describeasfollows按照以下格式描述：Identification標(biāo)識：Type類型：Purpose目的：2DataEntity2Description數(shù)據(jù)實體2描述DependencyDescription依賴性描述Thissectiondescribesrelationshipsamongthedesignentitiessuchassubsystems,datastores,modules,andprocessesetc..本節(jié)描述系統(tǒng)中的子系統(tǒng)，數(shù)據(jù)結(jié)構(gòu)，模塊，進(jìn)程等設(shè)計實體間的關(guān)系。Page9,Total16第9頁，共16頁

XXHighLevelDesignSpecificationXXXXHighLevelDesignSpecificationXX概要設(shè)計說明書Pleaseinputconfidentialitylevel請輸入密級Structurecharts,transactiondiagrams,MSC,ERdiagramcanbeusedtorepresentdependences.依賴關(guān)系描述可以使用結(jié)構(gòu)圖（交互）事務(wù)圖，消息序列圖,ER圖。RunningDesign運行設(shè)計Thissectiondescribeshowthemodulesandtheprocessesofthisdesignlevelcooperatetoperformthefunctionalrequirementsofthesystem.MSC,transactiondiagrams,Structurechartscanbeusedtorepresenttherunningprocedure.Note:AllthefunctionalrequirementsinSRSshouldbecoveredinthedescription.ForLevel2,Functionspecificationofthemoduletobedecomposedshouldbecovered.本章節(jié)描述本層設(shè)計的各個模塊和進(jìn)程是如何配合完成系統(tǒng)的功能需求.可以用消息序列圖（交互）事務(wù)圖,結(jié)構(gòu)圖等進(jìn)行描述,可以按照處理過程進(jìn)行分節(jié)描述,要注意的是描述的內(nèi)容應(yīng)該涵蓋所有SRS文檔的功能需求,對于二級設(shè)計來講,就是要涵蓋分解對象模塊的功能規(guī)格DataDependencies數(shù)據(jù)依賴關(guān)系Thissectiondescribesrelationshipsamongdatastores。本節(jié)描述數(shù)據(jù)結(jié)構(gòu)間的關(guān)系。ERdiagramcanbeusedtorepresentdependences.依賴關(guān)系描述可以使用ER圖。InterfaceDescription接口描述Thissectiondescribesinterfacesofthedesignentities（suchassubsystem,module,process）thatmakeupthesystem。本節(jié)描述軟件系統(tǒng)中設(shè)計實體（如子系統(tǒng)，模塊，進(jìn)程）的接口.Interfacefiles,parametertablescanbeusedtodescribeInterface.接口描述可以使用接口文件，參數(shù)表。Incaseofexternalentities,onlytheinterfacesrelevanttothesoftwarebeingdescribedneedbedescribed.對于外部實體只有同被描述軟件相關(guān)的接口才需描述。Module/SubsystemInterfaces模塊/子系統(tǒng)接口ThissectiondescribesinterfacesofModule/SubsystemInterfaces 。本節(jié)描述模塊/子系統(tǒng)的接口。1InterfacesProvidedbyModule/Subsystem1模塊/子系統(tǒng)1提供的接口Forinterfacefunction,followingformatshouldbeused:Interface1:Format:Page10,Total16第10頁，共16頁

XXHighLevelDesignSpecificationXXXXHighLevelDesignSpecificationXX概要設(shè)計說明書Pleaseinputconfidentialitylevel請輸入密級Input:Output:Return:DescribesthereturnvalueofthefunctionDescription:Describestheobjectiveoftheinterface.對于接口函數(shù)，可以采用以下形式描述：接口1：形式：輸入：輸出：返回：描述返回什么。描述：總體描述該接口實現(xiàn)的目的。2InterfacesProvidedbyModule/Subsystem2模塊/子系統(tǒng)2提供的接口ProcessInterfaces進(jìn)程接口Thissectiondescribesinterfacesofprocess 。本節(jié)描述進(jìn)程的接口。1Process1Description進(jìn)程1描述Theinterfacesbetweentheprocessesdescribethesharedmemory,protocoldataandmessages,etc.進(jìn)程間的接口主要是描述一些共享內(nèi)存，協(xié)議數(shù)據(jù)，消息等。Describeasfollows按照以下格式描述：Identification標(biāo)識：Type類型：Purpose目的：Functions功能列表：2Process2Description進(jìn)程2描述Page11,Total16第11頁，共16頁

XXHighLevelDesignSpecificationXXXXHighLevelDesignSpecificationXX概要設(shè)計說明書Pleaseinputconfidentialitylevel請輸入密級Level2DesignDescription(Optional)第二層設(shè)計描述(可選)EachentitythatisdefinedinL1andidentifiedforfurtherdescriptionshallbedescribedbyseparatesub-sectionsasmentionedbelow.L1 中定義的每個實體的進(jìn)一步設(shè)計在下面的章節(jié)進(jìn)行描述。Thiswillberepeatedforeachmoduleasfollows(SameasLevel1).ThedetailedsuggestionsarealsothesameasLevel1.對每個模塊重復(fù)使用下述的格式(和一層設(shè)計一樣)。具體的編寫建議參見第一層設(shè)計Modulename(1)模塊1名稱DecompositionDescription分解描述1Module/SubsystemDecomposition模塊/子系統(tǒng)分解1)Module/Subsystem1Description模塊/子系統(tǒng)1描述2)Module/Subsystem2Description模塊/子系統(tǒng)2描述2ConcurrentProcessDecomposition并發(fā)進(jìn)程處理分解1)Process1Description進(jìn)程1描述2)Process2Description進(jìn)程2描述DataEntityDescription數(shù)據(jù)實體描述Describeasfollows按照以下格式描述模塊內(nèi)部使用的多個數(shù)據(jù)實體：Identification標(biāo)識：Type&structure(ifapplicable) 類型及組成結(jié)構(gòu)(必要的話)：Purpose目的：Page12,Total16第12頁，共16頁

XXHighLevelDesignSpecificationXXXXHighLevelDesignSpecificationXX概要設(shè)計說明書Pleaseinputconfidentialitylevel請輸入密級DependencyDescription依賴性描述1RunningDesign運行設(shè)計2DataDependencies數(shù)據(jù)依賴關(guān)系InterfaceDescription接口描述1Module/SubsystemInterfaces模塊/子系統(tǒng)接口1)InterfacesProvidedbyModule/Subsystem1模塊/子系統(tǒng)1提供的接口2)InterfacesProvidedbyModule/Subsystem2模塊/子系統(tǒng)2提供的接口2ProcessInterfaces進(jìn)程接口1)Process1Description進(jìn)程1描述2)Process1Description進(jìn)程1描述Modulename(2)模塊2名稱Page13,Total16第13頁，共16頁

XXHighLevelDesignSpecificationXXXXHighLevelDesignSpecificationXX概要設(shè)計說明書Pleaseinputconfidentialitylevel請輸入密級ConfigurationandControl(Optional)配置和控制(可選)Startup啟動Describesthestepstostartupamodule.描述啟動一個模塊的步驟Closing關(guān)閉Describesthestepstocloseamodule.描述關(guān)閉一個模塊的步驟CreatingMIBTableItemMIB表項的創(chuàng)建Stepstocreateanewtableitem.Thetitleofthissectioncanbemodified.創(chuàng)建新表項的動作步驟。該節(jié)的標(biāo)題可以適當(dāng)更改DeletingMIBTableItemMIB表項的刪除Stepstodeleteatableitem.Thetitleofthissectioncanbemodified.刪除表項的動作步驟.該節(jié)的標(biāo)題可以適當(dāng)更改ModifyingMIBTableItemMIB表項的更改Stepstomodifyatableitem.Thetitleofthissectioncanbemodified.修改表項的動作步驟.該節(jié)的標(biāo)題可以適當(dāng)更改。Database(Optional)數(shù)據(jù)庫(可選)Entity,Attributesandtheirrelationships實體、屬性及它們之間的關(guān)系Thissectioncouldlistalltheentitiessuchasdatastores,averbosedescriptionofwhatthatentitypertainstoandlistofallitsattributes.Foreachoftheattributes,itsdatabase,thedatasi