概要設(shè)計說明書

1、XX High Level Design SpecificationXX 概要設(shè)計說明書Confidential 機密產(chǎn)品名稱Product name密級Confidentiality level機密 Confidential產(chǎn)品版本Product versionTotal 16pages 共16頁XX High Level Design SpecificationXX 概要設(shè)計說明書Prepared by 擬制Date日期yyyy-mm-ddReviewed by 評審人Date日期yyyy-mm-ddApproved by批準Date日期yyyy-mm-ddHuawei-3Com Tech

2、nologies Co., Ltd. 華為3Com技術(shù)有限公司All rights reserved版權(quán)所有 侵權(quán)必究（DVP05T01 V2.3/ IPD-CMM V3.0 / for internal use only）（DVP05T01 V2.3/ IPD-CMM V3.0 / 僅供內(nèi)部使用）Revision Record 修訂記錄Date日期Revision Version修訂版本CR ID / Defect IDCR號Sec No. 修改章節(jié)Change Description修改描述Author作者2001-06-081.00initial 初稿完成Name 作者名yyyy-mm-

3、dd1.01xxxx.x.x; y.y.yrevised xxx 修改XXXXxxXxx.Name作者名Catalog 目 錄1Introduction 簡介61.1Purpose 目的61.2Scope 范圍61.2.1Name 軟件名稱61.2.2Functions 軟件功能61.2.3Applications軟件應(yīng)用62High Level Design概要設(shè)計62.1Level 0 Design Description第零層設(shè)計描述62.1.1Software System Context Definition 軟件系統(tǒng)上下文定義62.1.2Design Considerations

4、(Optional)設(shè)計思路(可選)72.2Level 1 Design Description第一層設(shè)計描述82.2.1Decomposition Description分解描述82.2.2Dependency Description依賴性描述92.2.3Interface Description接口描述102.3Level 2 Design Description （Optional）第二層設(shè)計描述（可選）122.3.1Module name (1) 模塊1名稱122.3.2Module name (2) 模塊2名稱122.4Configuration and Control （Optio

5、nal）配置和控制（可選）142.4.1Startup 啟動142.4.2Closing 關(guān)閉142.4.3Creating MIB Table Item MIB表項的創(chuàng)建142.4.4Deleting MIB Table Item MIB表項的刪除142.4.5Modifying MIB Table Item MIB表項的更改142.5Database （Optional）數(shù)據(jù)庫（可選）142.5.1Entity, Attributes and their relationships 實體、屬性及它們之間的關(guān)系142.5.2E-R diagram 實體關(guān)系 圖14Table List 表目錄

6、Table1*表錯誤！未定義書簽。表1*表錯誤！未定義書簽。Figure List 圖目錄Figure 1*圖錯誤！未定義書簽。圖 1*圖錯誤！未定義書簽。XX High Level Design SpecificationXX 概要設(shè)計說明書Keywords 關(guān)鍵詞：Abstract 摘 要：List of abbreviations 縮略語清單：<對本文所用縮略語進行說明，要求提供每個縮略語的英文全名和中文解釋。Describe abbreviations in this document, full spelling of the abbreviation and Chinese

7、explanation should be provided.> Abbreviations縮略語Full spelling 英文全名Chinese explanation 中文解釋1 Introduction 簡介1.1 Purpose 目的This section should state the purpose of the document. It could also specify the intended audience. 這部分要描述文檔的目的。應(yīng)該指明讀者。1.2 Scope 范圍1.2.1 Name 軟件名稱Identify the software by name

8、對軟件命名1.2.2 Functions 軟件功能Explain what the software product(s) will and will not do (either directly or by reference to another software document).解釋軟件產(chǎn)品將完成或不完成的功能（可以直接描述也可以參考相關(guān)文檔）1.2.3 Applications軟件應(yīng)用Describe the application of the product (either directly or by reference to another software docume

9、nt)描述軟件的應(yīng)用（可直接描述也可以參考其它軟件文檔）2 High Level Design概要設(shè)計 2.1 Level 0 Design Description第零層設(shè)計描述2.1.1 Software System Context Definition 軟件系統(tǒng)上下文定義Describes the network organizing mode of the software system in actual environment (usually in drawings).Describes how the software system forms a functional ent

10、ity with other external entities (usually in drawings).首先描述本軟件系統(tǒng)在實際環(huán)境的組網(wǎng)方式（一般用圖描述）描述系統(tǒng)如何與外部實體一道組成功能實體（一般用圖描述）This section describes relationships between the software system to be developed and external entities. Architecture Diagram, Top level DFD (Data-Flow-Diagram) or transaction diagrams can be

11、used to describe architecture and interaction.本節(jié)還要描述待開發(fā)軟件系統(tǒng)與外部實體的關(guān)系.，可以使用系統(tǒng)架構(gòu)圖、頂層數(shù)據(jù)流圖、事務(wù)圖等來描述系統(tǒng)結(jié)構(gòu)和交互關(guān)系。All external entities of the software system (defined in Procedure of Design Specification) that interact with the software system, or affect the software system in a certain mode, for example, OS,

12、 driver, hardware, interrupt or other software systems.The property (such as message, library invoking) and type (such as OS service, communication service, system tools, etc.) of the interaction between external entities and this system. Only the contents that are helpful in the software design sho

13、uld be included while describing the features of an external entity. Instead of a complete description in this specification, you can make indexes to refer to the relative documents that describe the software design. For example, an index can be made for the programming guidance of the OS.所有系統(tǒng)外圍實體(在

14、設(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)編程手冊的索引2.1.2 Design Considerations (Optional)設(shè)計思路(可選)1. Design Methodology 設(shè)計方法Describe design methodology tha

15、t shall be used in the software system design.描述本軟件系統(tǒng)所采取的設(shè)計方法。2. Design Alternatives 設(shè)計可選方案 Analysis several alternatives of system design scheme, and specify the scheme that shall be used. 對本軟件系統(tǒng)的幾種設(shè)計方案進行分析、比較，并確定所采用的方案3. Design Constraints 設(shè)計約束1） Standards compliance 遵循標準Describe standards that so

16、ftware system shall comply with.描述本軟件所遵循的標準、規(guī)范2） Hardware Limitations 硬件限制Describe hardware limitations of the software system.描述本軟件系統(tǒng)實現(xiàn)的硬件限制3） Technology Limitations 技術(shù)限制Describe technology limitations of the software system.描述本軟件的技術(shù)限制4. Other Design Considerations 其它Describe other design considera

17、tions of the software system.描述其它有關(guān)的設(shè)計考慮2.2 Level 1 Design Description第一層設(shè)計描述Architecture of the software system shall be described here. 這里要描述軟件系統(tǒng)的總體結(jié)構(gòu)。Structure chart, Hierarchical decomposition diagram, natural language can be used to represent the architecture.總體結(jié)構(gòu)描述可以使用結(jié)構(gòu)圖，層次分解圖，自然語言。2.2.1 Deco

18、mposition Description分解描述1. Module/Subsystem Decomposition模塊/子系統(tǒng)分解This section describes subsystems ,module in the system.本節(jié)描述系統(tǒng)中的子系統(tǒng)和模塊。1） Module/Subsystem 1 Description模塊/子系統(tǒng)1描述Describe as follows 按照以下格式描述：Identification 標識：Type 類型：Purpose目的：Functions 功能列表：Requirement IDs to implement 要實現(xiàn)的需求ID:Sub

19、modules: 子模塊：If this module will be further decomposed into submodules, list all submodules here. 如果本模塊還要繼續(xù)劃分，列出下屬子模塊2） Module/Subsystem 2 Description模塊/子系統(tǒng)2描述2. Concurrent Process Decomposition并發(fā)進程處理分解This section describes concurrent processes in the system.本節(jié)描述系統(tǒng)中的并發(fā)進程。In case of external entitie

20、s, Subordinates attribute need not be described. 對于外部實體，從屬屬性不必描述。1） Process 1 Description進程1描述Describe as follows 按照以下格式描述：Identification 標識：Type 類型：Purpose目的：Functions 功能列表：This part describes the functions to be performed in the process. If the function has been described in module decomposition b

21、efore, description should be made on what functions of the modules are implemented in this process.描述本進程中要完成的功能，如功能已經(jīng)在前面的模塊分解中有描述，則重點描述本進程完成了哪些模塊的哪些功能。2） Process 2 Description進程2描述3. Data Decomposition數(shù)據(jù)分解This section describes data stores in the system.本節(jié)描述系統(tǒng)中的數(shù)據(jù)結(jié)構(gòu)。External data entities shall not

22、be described.外部數(shù)據(jù)實體不必描述。Describes the global data structure of the system, including: the data directly accessed by decomposed modules, and the data structure used in interface of decomposed modules. When describing the data, make sure the data is the global data of the level.本章節(jié)描述本系統(tǒng)中用到的全局數(shù)據(jù)結(jié)構(gòu)，其中至少

23、包括： 各分解模塊直接訪問的數(shù)據(jù)，被各分解模塊用來在接口中使用的結(jié)構(gòu)。描述數(shù)據(jù)時要注意該數(shù)據(jù)是否真正為本級模塊分解的公用數(shù)據(jù)。1） Data Entity 1 Description數(shù)據(jù)實體1描述Describe as follows 按照以下格式描述：Identification 標識：Type 類型：Purpose目的：2） Data Entity 2 Description數(shù)據(jù)實體2描述2.2.2 Dependency Description依賴性描述This section describes relationships among the design entities such a

24、s subsystems, data stores, modules, and processes etc.本節(jié)描述系統(tǒng)中的子系統(tǒng)，數(shù)據(jù)結(jié)構(gòu)，模塊，進程等設(shè)計實體間的關(guān)系。Structure charts, transaction diagrams, MSC, ER diagram can be used to represent dependences.依賴關(guān)系描述可以使用結(jié)構(gòu)圖（交互）事務(wù)圖，消息序列圖, ER圖。1. Running Design 運行設(shè)計This section describes how the modules and the processes of this de

25、sign level cooperate to perform the functional requirements of the system. MSC, transaction diagrams, Structure charts can be used to represent the running procedure. Note: All the functional requirements in SRS should be covered in the description. For Level 2, Function specification of the module

26、to be decomposed should be covered.本章節(jié)描述本層設(shè)計的各個模塊和進程是如何配合完成系統(tǒng)的功能需求. 可以用消息序列圖, (交互)事務(wù)圖, 結(jié)構(gòu)圖等進行描述, 可以按照處理過程進行分節(jié)描述, 要注意的是描述的內(nèi)容應(yīng)該涵蓋所有SRS文檔的功能需求, 對于二級設(shè)計來講, 就是要涵蓋分解對象模塊的功能規(guī)格2. Data Dependencies數(shù)據(jù)依賴關(guān)系This section describes relationships among data stores。本節(jié)描述數(shù)據(jù)結(jié)構(gòu)間的關(guān)系。ER diagram can be used to represent dep

27、endences.依賴關(guān)系描述可以使用ER圖。2.2.3 Interface Description接口描述This section describes interfaces of the design entities (such as subsystem, module, process)that make up the system。本節(jié)描述軟件系統(tǒng)中設(shè)計實體(如子系統(tǒng)，模塊，進程）的接口.Interface files, parameter tables can be used to describe Interface.接口描述可以使用接口文件，參數(shù)表。In case of exte

28、rnal entities, only the interfaces relevant to the software being described need be described.對于外部實體只有同被描述軟件相關(guān)的接口才需描述。1. Module/Subsystem Interfaces模塊/子系統(tǒng)接口This section describes interfaces of Module/Subsystem Interfaces。本節(jié)描述模塊/子系統(tǒng)的接口。1） Interfaces Provided by Module/Subsystem 1 模塊/子系統(tǒng)1提供的接口For inte

29、rface function, following format should be used:Interface 1:Format:Input:Output:Return: Describes the return value of the functionDescription: Describes the objective of the interface.對于接口函數(shù)，可以采用以下形式描述：接口1：形式：輸入：輸出：返回：描述返回什么。描述：總體描述該接口實現(xiàn)的目的。2） Interfaces Provided by Module/Subsystem 2 模塊/子系統(tǒng)2提供的接口2.

30、 Process Interfaces進程接口This section describes interfaces of process。本節(jié)描述進程的接口。1） Process 1 Description進程1描述The interfaces between the processes describe the shared memory, protocol data and messages, etc.進程間的接口主要是描述一些共享內(nèi)存，協(xié)議數(shù)據(jù)，消息等。Describe as follows 按照以下格式描述：Identification 標識：Type 類型：Purpose目的：Func

31、tions 功能列表：2） Process 2 Description進程2描述2.3 Level 2 Design Description （Optional）第二層設(shè)計描述（可選）Each entity that is defined in L1 and identified for further description shall be described by separate sub-sections as mentioned below.L1中定義的每個實體的進一步設(shè)計在下面的章節(jié)進行描述。This will be repeated for each module as foll

32、ows (Same as Level 1). The detailed suggestions are also the same as Level 1.對每個模塊重復(fù)使用下述的格式(和一層設(shè)計一樣)。具體的編寫建議參見第一層設(shè)計2.3.1 Module name (1) 模塊1名稱1. Decomposition Description 分解描述1） Module/Subsystem Decomposition模塊/子系統(tǒng)分解a） Module/Subsystem 1 Description模塊/子系統(tǒng)1描述b） Module/Subsystem 2 Description模塊/子系統(tǒng)2描述

33、*2） Concurrent Process Decomposition并發(fā)進程處理分解a） Process 1 Description進程1描述b） Process 2 Description進程2描述*2. Dependency Description 依賴性描述1） Running Design 運行設(shè)計2） Data Dependencies數(shù)據(jù)依賴關(guān)系*3. Interface Description 接口描述1） Module/Subsystem Interfaces模塊/子系統(tǒng)接口a） Interfaces Provided by Module/Subsystem 1 模塊/子系

34、統(tǒng)1提供的接口b） Interfaces Provided by Module/Subsystem 2 模塊/子系統(tǒng)2提供的接口*2） Process Interfaces進程接口a） Process 1 Description進程1描述b） Process 1 Description進程1描述*2.3.2 Module name (2) 模塊2名稱*2.4 Configuration and Control （Optional）配置和控制（可選）2.4.1 Startup 啟動 Describes the steps to start up a module.描述啟動一個模塊的步驟2.4.2

35、 Closing 關(guān)閉Describes the steps to close a module.描述關(guān)閉一個模塊的步驟2.4.3 Creating MIB Table Item MIB表項的創(chuàng)建Steps to create a new table item. The title of this section can be modified.創(chuàng)建新表項的動作步驟。該節(jié)的標題可以適當更改2.4.4 Deleting MIB Table Item MIB表項的刪除Steps to delete a table item. The title of this section can be mod

36、ified.刪除表項的動作步驟. 該節(jié)的標題可以適當更改2.4.5 Modifying MIB Table Item MIB表項的更改Steps to modify a table item. The title of this section can be modified.修改表項的動作步驟. 該節(jié)的標題可以適當更改。2.5 Database （Optional）數(shù)據(jù)庫（可選）2.5.1 Entity, Attributes and their relationships 實體、屬性及它們之間的關(guān)系This section could list all the entities such as data stores, a verbose description of what that entity pertains to and list of all its att