文章描述:-2022年5月19日發(作者:燕鎧)產品名稱Productname產品版本Productversion密級ConfidentialitylevelTotal16pages共16頁XXHighLevelDesignSpecificationXX概要設計說明書Preparedby擬制Reviewedby評審人Approvedby批準ame+ID姓名+工號Date日期Date日期Date日期yyyy
-

2022年5月19日發
(作者:燕鎧)
產品名稱Productname
產品版本Productversion
密級Confidentialitylevel
Total16pages共16頁
XXHighLevelDesignSpecification
XX概要設計說明書
Preparedby
擬制
Reviewedby
評審人
Approvedby
批準
ame+ID
姓名+工號
Date
日期
Date
日期
Date
日期
yyyy-mm-dd
yyyy-mm-dd
yyyy-mm-dd
XXXXCo.,Ltd.
XXXX有限公司
XXHighLevelDesignSpecification
XX概要設計說明書
Pleaseinputconfidentialitylevel
請輸入密級
RevisionRecord修訂記錄
Date
日期
Revisio
n
Version
修訂
版本
CRID
/
Defec
tID
CR號
Sec
o.
修改
章節
ChangeDescription
修改描述
Author
作者
Page2,Total16第2頁,共16頁
XXHighLevelDesignSpecification
XX概要設計說明書
Pleaseinputconfidentialitylevel
請輸入密級
Catalog目錄
1Introduction簡介.....................................................................................................................6
1.1
1.2
Purpose目的.....................................................................................................................6
Scope范圍........................................................................................................................6
ame軟件名稱............................................................................................................6
Functi軟件功能......................................................................................................6
Applicati軟件應用...................................................................................................6
1.2.1
1.2.2
1.2.3
2HighLevelDesign概要設計.....................................................................................................6
2.1Level0DesignDescription第零層設計描述......................................................................6
SoftwareSystemContextDefinition軟件系統上下文定義..........................................6
DesignCiderati(Optional)設計思路(可選).......................................................7
2.1.1
2.1.2
2.2Level1DesignDescription第一層設計描述......................................................................8
DecompositionDescription分解描述...........................................................................8
DependencyDescription依賴性描述............................................................................9
InterfaceDescription接口描述....................................................................................10
2.2.1
2.2.2
2.2.3
2.3Level2DesignDescription(Optional)第二層設計描述(可選)................................12
Modulename(1)模塊1名稱......................................................................................12
Modulename(2)模塊2名稱......................................................................................13
2.3.1
2.3.2
2.4ConfigurationandControl(Optional)配置和控制(可選).........................................14
Startup啟動................................................................................................................14
Closing關閉...............................................................................................................14
CreatingMIBTableItemMIB表項的創建..................................................................14
DeletingMIBTableItemMIB表項的刪除...................................................................14
ModifyingMIBTableItemMIB表項的更改................................................................14
2.4.1
2.4.2
2.4.3
2.4.4
2.4.5
2.5Database(Optional)數據庫(可選)..........................................................................14
Entity,Attributesandtheirrelatihips實體、屬性及它們之間的關系....................14
E-Rdiagram實體關系圖..........................................................................................14
2.5.1
2.5.2
Page3,Total16第3頁,共16頁
XXHighLevelDesignSpecification
XX概要設計說明書
Pleaseinputconfidentialitylevel
請輸入密級
TableList表目錄
Table1**表..........................................................................................................錯誤!未定義書簽。
表1**表...............................................................................................................錯誤!未定義書簽。
FigureList圖目錄
Figure1**圖........................................................................................................錯誤!未定義書簽。
圖1**圖...............................................................................................................錯誤!未定義書簽。
Page4,Total16第4頁,共16頁
XXHighLevelDesignSpecification
XX概要設計說明書
Pleaseinputconfidentialitylevel
請輸入密級
XXHighLevelDesignSpecification
XX概要設計說明書
Keywords關鍵詞:
Abstract摘要:
Listofabbreviati縮略語清單:<對本文所用縮略語進行說明,要求提供每個縮略語的英文
全名和中文解釋。Describeabbreviatiinthisdocument,fullspellingofthe
abbreviationandChineseexplanatihouldbeprovided.>
Abbreviati縮略語Fullspelling英文全名Chineseexplanation中文解釋
Page5,Total16第5頁,共16頁
XXHighLevelDesignSpecification
XX概要設計說明書
Pleaseinputconfidentialitylevel
請輸入密級
1
1.1
Introduction簡介
Purpose目的
dalsospecifytheintended
audience.
這部分要描述文檔的目的。應該指明讀者。
1.2Scope范圍
1.2.1ame軟件名稱
Identifythesoftwarebyname
對軟件命名
1.2.2Functi軟件功能
Explainwhatthesoftwareproduct(s)willandwillnotdo(eitherdirectlyorbyreferenceto
anothersoftwaredocument).
解釋軟件產品將完成或不完成的功能(可以直接描述也可以參考相關文檔)
1.2.3Applicati軟件應用
Describetheapplicationoftheproduct(eitherdirectlyorbyreferencetoanothersoftware
document)
描述軟件的應用(可直接描述也可以參考其它軟件文檔)
2
2.1
HighLevelDesign概要設計
Level0DesignDescription第零層設計描述
2.1.1SoftwareSystemContextDefinition軟件系統上下文定義
Describesthenetworkorganizingmodeofthesoftwaresysteminactualenvironment
(usuallyindrawings).
Describeshowthesoftwaresystemformsafunctionalentitywithotherexternalentities
(usuallyindrawings).
首先描述本軟件系統在實際環境的組網方式(一般用圖描述)
描述系統如何與外部實體一道組成功能實體(一般用圖描述)
Page6,Total16第6頁,共16頁
XXHighLevelDesignSpecification
XX概要設計說明書
Pleaseinputconfidentialitylevel
請輸入密級
Thissectiondescribesrelatihipsbetweenthesoftwaresystemtobedevelopedand
ectureDiagram,ToplevelDFD(Data-Flow-Diagram)ortransaction
diagramscanbeusedtodescribearchitectureandinteraction.
本節還要描述待開發軟件系統與外部實體的關系.,可以使用系統架構圖、頂層數據流圖、事
務圖等來描述系統結構和交互關系。
Allexternalentitiesofthesoftwaresystem(definedinProcedureofDesignSpecification)
thatinteractwiththesoftwaresystem,oraffectthesoftwaresysteminacertainmode,for
example,OS,driver,hardware,interruptorothersoftwaresystems.
Theproperty(suchasmessage,libraryinvoking)andtype(suchasOSservice,
communicatiervice,systemtools,etc.)oftheinteractionbetweenexternalentitiesandthis
econtentsthatarehelpfulinthesoftwaredesignshouldbeincludedwhile
dofacompletedescriptioninthis
specification,youcanmakeindexestorefertotherelativedocumentsthatdescribethesoftware
mple,anindexcanbemadefortheprogrammingguidanceoftheOS.
所有系統外圍實體(在設計規格流程中有定義),這些實體與軟件系統發生交互作用或以某種方
式影響軟件系統,比如,操作系統,驅動程序,硬件,中斷,其它軟件系統等.
外圍實體和本系統相互作用的性質(比如,消息,庫調用)和類型(比如,OS服務,通信服務,
系統工具等)。描述外部實體的特性時要注意該描述一定要有助本軟件的設計和描述。為了本文檔
內容的完整性,可以采用對于描述相關設計實體文檔索引的方式:如對于操作系統編程手冊的索
引
2.1.2DesignCiderati(Optional)設計思路(可選)
2.1.2.1DesignMethodology設計方法
Describedesignmethodologythatshallbeusedinthesoftwaresystemdesign.描述本軟件
系統所采取的設計方法。
2.1.2.2DesignAlternatives設計可選方案
Analysisseveralalternativesofsystemdesignscheme,andspecifytheschemethatshall
beused.對本軟件系統的幾種設計方案進行分析、比較,并確定所采用的方案
2.1.2.3DesignCtraints設計約束
1Standardscompliance遵循標準
Describestandardsthatsoftwaresystemshallcomplywith.描述本軟件所遵循的標準、規范
Page7,Total16第7頁,共16頁
XXHighLevelDesignSpecification
XX概要設計說明書
Pleaseinputconfidentialitylevel
請輸入密級
2HardwareLimitati硬件限制
Describehardwarelimitatiofthesoftwaresystem.描述本軟件系統實現的硬件限制
3TechnologyLimitati技術限制
Describetechnologylimitatiofthesoftwaresystem.描述本軟件的技術限制
2.1.2.4OtherDesignCiderati其它
Describeotherdesigncideratiofthesoftwaresystem.描述其它有關的設計考慮
2.2Level1DesignDescription第一層設計描述
Architectureofthesoftwaresystemshallbedescribedhere.這里要描述軟件系統的總體結
構。
Structurechart,Hierarchicaldecompositiondiagram,naturallanguagecanbeusedto
representthearchitecture.總體結構描述可以使用結構圖,層次分解圖,自然語言。
2.2.1DecompositionDescription分解描述
2.2.1.1Module/SubsystemDecomposition模塊/子系統分解
Thissectiondescribessubsystems,moduleinthesystem..本節描述系統中的子系統和模
塊。
1Module/Subsystem1Description模塊/子系統1描述
Describeasfollows按照以下格式描述:
Identification標識:
Type類型:
Purpose目的:
Functi功能列表:
RequirementIDstoimplement要實現的需求ID:
Submodules:子模塊:Ifthismodulewillbefurtherdecomposedintosubmodules,listall
submoduleshere.如果本模塊還要繼續劃分,列出下屬子模塊
2Module/Subsystem2Description模塊/子系統2描述
2.2.1.2ConcurrentProcessDecomposition并發進程處理分解
Thissectiondescribesconcurrentprocessesinthesystem..本節描述系統中的并發進程。
Incaseofexternalentities,Subordinatesattributeneednotbedescribed.對于外部實體,從
屬屬性不必描述。
Page8,Total16第8頁,共16頁
XXHighLevelDesignSpecification
XX概要設計說明書
Pleaseinputconfidentialitylevel
請輸入密級
1Process1Description進程1描述
Describeasfollows按照以下格式描述:
Identification標識:
Type類型:
Purpose目的:
Functi功能列表:
unctionhasbeen
describedinmoduledecompositionbefore,descriptihouldbemadeonwhatfunctiofthe
modulesareimplementedinthisprocess.
描述本進程中要完成的功能,如功能已經在前面的模塊分解中有描述,則重點描述本進程完
成了哪些模塊的哪些功能。
2Process2Description進程2描述
2.2.1.3DataDecomposition數據分解
Thissectiondescribesdatastoresinthesystem..本節描述系統中的數據結構。
Externaldataentitieallnotbedescribed.外部數據實體不必描述。
Describestheglobaldatastructureofthesystem,including:thedatadirectlyaccessedby
decomposedmodules,
describingthedata,makesurethedataistheglobaldataofthelevel.
本章節描述本系統中用到的全局數據結構,其中至少包括:各分解模塊直接訪問的數據,被
各分解模塊用來在接口中使用的結構。描述數據時要注意該數據是否真正為本級模塊分解的公用
數據。
1DataEntity1Description數據實體1描述
Describeasfollows按照以下格式描述:
Identification標識:
Type類型:
Purpose目的:
2DataEntity2Description數據實體2描述
2.2.2DependencyDescription依賴性描述
Thissectiondescribesrelatihipsamongthedesignentitiessuchassubsystems,data
stores,modules,andprocessesetc..本節描述系統中的子系統,數據結構,模塊,進程等設計實
體間的關系。
Page9,Total16第9頁,共16頁
XXHighLevelDesignSpecification
XX概要設計說明書
Pleaseinputconfidentialitylevel
請輸入密級
Structurecharts,transactiondiagrams,MSC,ERdiagramcanbeusedtorepresent
dependences.依賴關系描述可以使用結構圖(交互)事務圖,消息序列圖,ER圖。
2.2.2.1RunningDesign運行設計
Thissectiondescribeshowthemodulesandtheprocessesofthisdesignlevelcooperateto
,transactiondiagrams,Structurecharts
:AllthefunctionalrequirementsinSRS
el2,Functipecificationofthemoduletobe
decomposedshouldbecovered.
本章節描述本層設計的各個模塊和進程是如何配合完成系統的功能需求.可以用消息序列圖,
(交互)事務圖,結構圖等進行描述,可以按照處理過程進行分節描述,要注意的是描述的內容應該涵
蓋所有SRS文檔的功能需求,對于二級設計來講,就是要涵蓋分解對象模塊的功能規格
2.2.2.2DataDependencies數據依賴關系
Thissectiondescribesrelatihipsamongdatastores。
本節描述數據結構間的關系。
ERdiagramcanbeusedtorepresentdependences.
依賴關系描述可以使用ER圖。
2.2.3InterfaceDescription接口描述
Thissectiondescribesinterfacesofthedesignentities(suchassubsystem,module,
process)thatmakeupthesystem。
本節描述軟件系統中設計實體(如子系統,模塊,進程)的接口.
Interfacefiles,parametertablescanbeusedtodescribeInterface.
接口描述可以使用接口文件,參數表。
Incaseofexternalentities,onlytheinterfacesrelevanttothesoftwarebeingdescribedneed
bedescribed.
對于外部實體只有同被描述軟件相關的接口才需描述。
2.2.3.1Module/SubsystemInterfaces模塊/子系統接口
ThissectiondescribesinterfacesofModule/SubsystemInterfaces。本節描述模塊/子系統
的接口。
1InterfacesProvidedbyModule/Subsystem1模塊/子系統1提供的接口
Forinterfacefunction,followingformatshouldbeused:
Interface1:
Format:
Page10,Total16第10頁,共16頁
XXHighLevelDesignSpecification
XX概要設計說明書
Pleaseinputconfidentialitylevel
請輸入密級
Input:
Output:
Return:Describesthereturnvalueofthefunction
Description:Describestheobjectiveoftheinterface.
對于接口函數,可以采用以下形式描述:
接口1:
形式:
輸入:
輸出:
返回:描述返回什么。
描述:總體描述該接口實現的目的。
2InterfacesProvidedbyModule/Subsystem2模塊/子系統2提供的接口
2.2.3.2ProcessInterfaces進程接口
Thissectiondescribesinterfacesofprocess。本節描述進程的接口。
1Process1Description進程1描述
Theinterfacesbetweentheprocessesdescribethesharedmemory,protocoldataand
messages,etc.
進程間的接口主要是描述一些共享內存,協議數據,消息等。
Describeasfollows按照以下格式描述:
Identification標識:
Type類型:
Purpose目的:
Functi功能列表:
2Process2Description進程2描述
Page11,Total16第11頁,共16頁
XXHighLevelDesignSpecification
XX概要設計說明書
Pleaseinputconfidentialitylevel
請輸入密級
2.3Level2DesignDescription(Optional)第二層設計描述(可選)
EachentitythatisdefinedinL1andidentifiedforfurtherdescriptihallbedescribedby
separatesub-sectiasmentionedbelow.L1中定義的每個實體的進一步設計在下面的章節進行
描述。
Thiswillberepeatedforeachmoduleasfollows(SameasLevel1).Thedetailed
suggestiarealsothesameasLevel1.
對每個模塊重復使用下述的格式(和一層設計一樣)。具體的編寫建議參見第一層設計
2.3.1Modulename(1)模塊1名稱
2.3.1.1DecompositionDescription分解描述
1Module/SubsystemDecomposition模塊/子系統分解
1)Module/Subsystem1Description模塊/子系統1描述
2)Module/Subsystem2Description模塊/子系統2描述
******
2ConcurrentProcessDecomposition并發進程處理分解
1)Process1Description進程1描述
2)Process2Description進程2描述
******
2.3.1.2DataEntityDescription數據實體描述
Describeasfollows按照以下格式描述模塊內部使用的多個數據實體:
Identification標識:
Type&structure(ifapplicable)類型及組成結構(必要的話):
Purpose目的:
Page12,Total16第12頁,共16頁
XXHighLevelDesignSpecification
XX概要設計說明書
Pleaseinputconfidentialitylevel
請輸入密級
2.3.1.3DependencyDescription依賴性描述
1
2
RunningDesign運行設計
DataDependencies數據依賴關系
******
2.3.1.4InterfaceDescription接口描述
1Module/SubsystemInterfaces模塊/子系統接口
1)InterfacesProvidedbyModule/Subsystem1模塊/子系統1提供的接口
2)InterfacesProvidedbyModule/Subsystem2模塊/子系統2提供的接口
******
2ProcessInterfaces進程接口
1)Process1Description進程1描述
2)Process1Description進程1描述
******
2.3.2Modulename(2)模塊2名稱
******
Page13,Total16第13頁,共16頁
XXHighLevelDesignSpecification
XX概要設計說明書
Pleaseinputconfidentialitylevel
請輸入密級
2.4ConfigurationandControl(Optional)配置和控制(可選)
2.4.1Startup啟動
Describesthestepstostartupamodule.
描述啟動一個模塊的步驟
2.4.2Closing關閉
Describesthestepstocloseamodule.
描述關閉一個模塊的步驟
2.4.3CreatingMIBTableItemMIB表項的創建
leofthissectioncanbemodified.
創建新表項的動作步驟。該節的標題可以適當更改
2.4.4DeletingMIBTableItemMIB表項的刪除
leofthissectioncanbemodified.
刪除表項的動作步驟.該節的標題可以適當更改
2.4.5ModifyingMIBTableItemMIB表項的更改
leofthissectioncanbemodified.
修改表項的動作步驟.該節的標題可以適當更改。
2.5Database(Optional)數據庫(可選)
2.5.1Entity,Attributesandtheirrelatihips實體、屬性及它們之間的關系
Thissectioncouldlistalltheentitiessuchasdatastores,averbosedescriptionofwhatthat
hoftheattributes,itsdatabase,thedatasize,
specificcocific
ctraintsforthatentityanditsrelatihipwithotherentitieouldalsobenoted.
本節列出所有的數據存儲類的實體,詳細描述實體的內容和并列出全部屬性。對每個屬性,
詳細描述其數據庫、數據大小、特定約束。實體的所有約束及實體間的關系也要注明。
2.5.2E-Rdiagram實體關系圖
ThissectihoulddisplaytheE-Rdiagramforalltheentitieslistedabove.
Page14,Total16第14頁,共16頁
XXHighLevelDesignSpecification
XX概要設計說明書
Pleaseinputconfidentialitylevel
請輸入密級
本節描述關于上節提到的所有實體的E-R圖
Page15,Total16第15頁,共16頁
XXHighLevelDesignSpecification
XX概要設計說明書
Pleaseinputconfidentialitylevel
請輸入密級
Listofreference參考資料清單:
Pleaselistreferredliteratureandrelateddocuments,format:
請羅列本文檔所參考的有關參考文獻和相關文檔,格式如下:
Author+bookname(ormagazine,literature,document)+publishingcompany(orissueo.,
volumeo.,internaldocumentationID)+publishingdate+startandendpagenumber,
作者+書名(或雜志、文獻、文檔)+出版社(或期號、卷號、公司文檔編號)+出版日期+
起止頁碼
Examples:
例如:
[1],“ASimpleModelofFeedbackOscillatoroiseSpectrum,”,pp329-
330,February1966(英文文章格式)
[2]r,Phase-LockedLoopCircuitDesign,PrenticeHall,ewJersey,1991(英文書籍
格式)
[3]王陽元,奚雪梅等,“薄膜SOI/CMOSSPICE電路模擬”,電子學報,vol.22,o.5,1994
(中文文章格式)
[4]鄭筠,《MOS存儲系統及技術》,科學出版社,1990(中文書籍格式)
[5]XXX,SDXXX用戶手冊V1.1,基礎部文檔室,2001/4/26
Page16,Total16第16頁,共16頁
-

發表評論