華為軟件概要設計模板

1、XX High Level Design SpecificationPlease input confidentiality levelXX概要設計說明書請輸入密級產(chǎn)品名稱Product name密級 Confidentiality level產(chǎn)品版本 Product versionTotal 16pages 共 16 頁XX High Level Design SpecificationXX概要設計說明書Prepared byName+IDDateyyyy-mm-dd擬制姓名+工號日期Reviewed byDateyyyy-mm-dd評審人日期Approved byDateyyyy-mm-d

2、d批準日期XXXX Co., Ltd.XXXX有限公司Revision Record 修訂記錄Date日期Revisio nVersion 修訂 版本CR ID/Defec t IDCR號Sec No. 修改早下Change Description修改描述Author作者Page 3 , Total 16 第 5頁，共 16頁Catalog 目錄1 Introduction 簡介61.1 Purpose 目的 61.2 Scope 范圍 61.2.1 Name軟件名稱 61.2.2 Functions 軟件功能 61.2.3 Applications 軟件應用 62 High Level De

3、sign 概要設計 62.1 Level 0 Design Description 第零層設計描述 62.1.1 Software System Context Definition軟件系統(tǒng)上下文定義 62.1.2 Design Considerations (Optional)設計思路(可選) 72.2 Level 1 Design Description 第層設計描述 82.2.1 Decomposition Description 分解描述 82.2.2 Dependency Description 依賴性描述 92.2.3 Interface Description 接口描述 1 02

4、.3 Level 2 Design Description (Optional )第二層設計描述(可選) 122.3.1 Module name (1)模塊 1 名稱 122.3.2 Module name (2)模塊 2 名稱 132.4 Configuration and Control (Optional )配置和控制(可選) 142.4.1 Startup 啟動 142.4.2 Closing 關(guān)閉 142.4.3 Creating MIB TableItem MIB表項的創(chuàng)建 142.4.4 Deleting MIB TableItem MIB表項的刪除 142.4.5 Modify

5、ing MIB Table Item MIB表項的更改 142.5 Database (Optional )數(shù)據(jù)庫(可選) 142.5.1 Entity, Attributes and their relationships 實體、屬性及它們之間的關(guān)系 142.5.2 E-R diagram實體關(guān)系 圖 14Table List 表目錄Tablel* 表錯誤!未定義書簽。表1 *表錯誤!未定義書簽。Figure List 圖目錄Figure 1* 圖錯誤!未定義書簽。圖1*圖錯誤!未定義書簽。XX High Level Design SpecificationXX概要設計說明書Please i

6、nput confidentiality level請輸入密級XX High Level Design SpecificationXX概要設計說明書Keywords 關(guān)鍵詞：Abstract 摘要：List of abbreviations縮略語清單：對本文所用縮略語進行說明，要求提供每個縮略語的英文全名和中文解釋。Describe abbreviations in this document, full spelling of theabbreviation and Chinese explanation should be provided.Abbreviations 縮略語Full sp

7、elling央義全名Chinese explanation中文解釋Page 12 , Total 16 第 13頁，共 16頁1 Introduction 簡介1.1 Purpose 目的This section should state the purpose of the document. It could also specify the intended audience.這部分要描述文檔的目的。應該指明讀者。1.2 Scope 范圍1.2.1 Name軟件名稱Identify the software by name對軟件命名1.2.2 Functions 軟件功能Explain

8、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 軟件應用Describe the application of the product (either directly or by reference to another software document)描述軟件的應用(可直接描述也可以參考其它軟件文檔)2 Hi

9、gh Level Design 概要設計2.1 Level 0 Design Description 第零層設計描述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 entity with other external entitie

10、s (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 used to describe architecture a

11、nd interaction.本節(jié)還要描述待開發(fā)軟件系統(tǒng)與外部實體的關(guān)系.，可以使用系統(tǒng)架構(gòu)圖、頂層數(shù)據(jù)流圖、事 務圖等來描述系統(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, driver, hardware, interrupt o

12、r 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 should be included while describi

13、ng 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)外圍實體(在設計規(guī)格流程中有定義)，這些實體與軟件系統(tǒng)發(fā)生交互作用或以某

14、種方 式影響軟件系統(tǒng)，比如，操作系統(tǒng)，驅(qū)動程序，硬件，中斷，其它軟件系統(tǒng)等.外圍實體和本系統(tǒng)相互作用的性質(zhì)(比如，消息，庫調(diào)用)和類型(比如，OS服務，通信服務， 系統(tǒng)工具等)。描述外部實體的特性時要注意該描述一定要有助本軟件的設計和描述。為了本文檔內(nèi)容的完整性，可以采用對于描述相關(guān)設計實體文檔索引的方式：如對于操作系統(tǒng)編程手冊的索 引2.1.2 Design Considerations (Optional)設計思路(可選) Design Methodology 設計方法Describe design methodology that shall be used in the

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

16、all 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ù)限制 Other Design Considerations 其它Describe other design considerations of the

17、software system.描述其它有關(guān)的設計考慮2.2 Level 1 Design Description 第一層設計描述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 Decomposition Des

18、cription 分解描述 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:Submodu

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

20、ities, 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 decompositi

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

22、es shall not 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)中用

23、到的全局數(shù)據(jù)結(jié)構(gòu)，其中至少包括：各分解模塊直接訪問的數(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 desi

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

25、e processes of this design 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 specif

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

27、e used to represent dependences.依賴關(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)中設計實體（如子系統(tǒng)，模塊，進程）的接口 .Interface files, parameter tables can be used to describe Interface.接口描述可

28、以使用接口文件，參數(shù)表。In case of external entities, only the interfaces relevant to the software being described need be described.對于外部實體只有同被描述軟件相關(guān)的接口才需描述。 Module/Subsystem Interfaces 模塊/子系統(tǒng)接口This section describes interfaces of Module/Subsystem Interfaces 。 本節(jié)描述模塊 /子系統(tǒng) 的接口。1 Interfaces Provided by Mod

29、ule/Subsystem 1 模塊/子系統(tǒng) 1 提供的接口For interface 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 Provid

30、ed by Module/Subsystem 2 模塊/子系統(tǒng) 2 提供的接口 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 follow

31、s按照以下格式描述：Identification 標識：Type類型：Purpose 目 的:Functions功能列表：2 Process 2 Description 進程 2 描述2.3 Level 2 Design Description (Optional)第二層設計描述(可選)Each entity that is defined in L1 and identified for further description shall be described by separate sub-sections as mentioned below.L1中定義的每個實體的進一步設計在下面的

32、章節(jié)進行描述。This will be repeated for each module as follows (Same as Level 1). The detailed suggestions are also the same as Level 1.對每個模塊重復使用下述的格式(和一層設計一樣)。具體的編寫建議參見第一層設計2.3.1 Module name (1)模塊 1 名稱 Decomposition Description 分解描述1 Module/Subsystem Decomposition 模塊/子系統(tǒng)分解1) Module/Subsystem 1 Desc

33、ription 模塊/子系統(tǒng) 1 描述2) Module/Subsystem 2 Description 模塊/子系統(tǒng) 2 描述 *2 Concurrent Process Decomposition 并發(fā)進程處理分解1) Process 1 Description 進程 1 描述2) Process 2 Description 進程 2 描述 * Data Entity Description 數(shù)據(jù)實體描述Describe as follows按照以下格式描述模塊內(nèi)部使用的多個數(shù)據(jù)實體：Identification 標識：Type & structure(if appl

34、icable)類型及組成結(jié)構(gòu)(必要的話)：Purpose 目 的：XX High Level Design SpecificationXX概要設計說明書Please input confidentiality level請輸入密級 Dependency Description 依賴性描述1 Running Design 運行設計2 Data Dependencies數(shù)據(jù)依賴關(guān)系* Interface Description 接口描述1 Module/Subsystem Interfaces 模塊/子系統(tǒng)接口1) Interfaces Provided by Modu

35、le/Subsystem 1 模塊/子系統(tǒng) 1 提供的接口2) Interfaces Provided by Module/Subsystem 2 模塊/子系統(tǒng) 2 提供的接口 *2Process Interfaces 進程接口1) Process 1 Description 進程 1 描述2) Process 1 Description 進程 1 描述 *2.3.2 Module name (2)模塊 2 名稱*Page # , Total 16 第 13頁,共 16頁Please input confidentiality level請輸入密級2.4 Configuration and C

36、ontrol (Optional)配置和控制(可選)2.4.1 Startup 啟動Describes the steps to start up a module.描述啟動一個模塊的步驟2.4.2 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.

37、4 Deleting MIB Table Item MIB 表項的刪除Steps to delete a table item. The title of this section can be modified.刪除表項的動作步驟.該節(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 pertai