華為軟件詳細(xì)設(shè)計模板

1、華為軟件詳細(xì)設(shè)計模板產(chǎn)品名稱Product name密級 Confidentiality level產(chǎn)品版本Product versionTotal 12pages 共12頁XX Low Level Design SpecificationXX詳細(xì)設(shè)計說明書Preparedby擬制Reviewed by評審人Approved by批準(zhǔn)Name+ID姓名+工號Dat yyyy-mm- e dd日期Dat yyyy-mm- e dd日期Dat yyyymm e dd日期Please input confidentialitylevel請輸入密級XX Low Level Design Specifi

2、cationXX詳細(xì)設(shè)計說明書XXXX Co., Ltd.XXXX有限公司Revision Record 修訂記錄Date日期Revi sion Vers ion 修訂 版本CR ID/ De fee tID CR 號Sec No改 章 節(jié)Change Description 修改描述Auth or 作者11.Page5,Total 12 第5頁，共 12頁Catalog 目錄1 Introduction 簡介6Purpose 目的61.2 Scope 范圍62 Detailed Design 詳細(xì)設(shè)計62.1 Module 1 Detail Design 模塊 1 詳細(xì)設(shè)計62.1.1 Da

3、taDescription 數(shù)據(jù)描述62.1.2 Function Description 函數(shù)描述 82.2 Module 2 Datail Design 模塊2詳細(xì)設(shè)計 112.3 Error Process 錯誤處理112.3.1 SystemError 系統(tǒng)錯誤11Interface Error 接口錯誤2.3.2. .11Protocol Error 協(xié)議錯誤2.3.3.,11Table List表目錄Tablel表錯誤！未定義書簽。表1杯表錯誤！未定義書簽。Figure List目錄Figure 1. Module 1 Structure Chart 模塊 1 結(jié)構(gòu)圖8XX Low

4、 Level Design SpecificationXX詳細(xì)設(shè)計說明書Keywords關(guān)鍵詞：Abstract 摘 要:List of abbreviations縮略語清單：v對本文所用縮略語進(jìn)行說明,要求提供每個縮略語的英文全 名和中文解釋。Describe abbreviations inthis document, full spelling of the abbreviation and Chinese explanation should be provided.Abbreviations 縮略語Full spelling 英文全名Chinese explanation 中文 解釋

5、1 Introduction 簡介1.1 Purpose 目的To descript the purpose of this document In general, LLD specification can be used to guide the coding activities directly.描述本文的目的,一般詳細(xì)設(shè)計必須能夠直接指導(dǎo)編碼活動。1.2 Scope 范圍This section should address areas which this document includes and that are specifically excludes.本節(jié)應(yīng)描述文檔所包

6、括和不包括的內(nèi)容。2 Detailed Design 詳細(xì)設(shè)計This section should focus on the description of the detailed design of the software entities that are a part of the software being described by the HLD Specification o .對于在概要設(shè)計說明書中給出的軟件實體,本節(jié)集中描述它們的詳細(xì)描述部分。2.1 Module 1 Detail Design 模塊 1 詳細(xì)設(shè)計Describe data that defined or

7、 used in themodule, including:simple data /.e. global variable, constant or macro within the module;complex data /.e. Structure or union.描述模塊中定義和使用的數(shù)據(jù),包括 簡單數(shù)據(jù),如模塊級的全局變量、常量、宏;復(fù)合數(shù)據(jù),如模塊內(nèi)部的結(jié)構(gòu)、聯(lián)合;2.1.1 Data Description 數(shù)據(jù)描述Describe simple variables, constant or macro of the module in section 2.7 1.1;Desc

8、ribe complex data from section 2.1.1.2, such as structure, union;在2.1.1.1中描述本模塊中的簡單變量、常量、 宏;從2.12起描述本模塊中的復(fù)合數(shù)據(jù),如結(jié)構(gòu)、聯(lián)合等;1. Simple Data Description 簡單數(shù)據(jù)描述 describe simple variables、constant ormacro used or defined in this module;描述在本模塊中定義和使用的簡單變量、常量、宏;Describes simple variables, constants used or defin

9、ed in this module;The description of simple data should follow the format below:Function Description: Describing the usage of the dataData Definition: Defining the data按照下列格式進(jìn)行簡單數(shù)據(jù)的描述 功能描述描述該數(shù)據(jù)的用途 數(shù)據(jù)定義:定義該數(shù)據(jù)2. Structure 1 結(jié)構(gòu) 1Define and describe the Data structure (include union)定義和說明該數(shù)據(jù)結(jié)構(gòu)(包括聯(lián)合);The

10、 description of data structure should follow the format below:Data Structure Description: Describing the usage of the data structureData Structure Definition: Defining the data structure with the actual programing languageData Items Description:Data TypeData Item DefinitionData Item Description按照下列格

11、式進(jìn)行數(shù)據(jù)結(jié)構(gòu)的描述數(shù)據(jù)結(jié)構(gòu)描述:描述該數(shù)據(jù)結(jié)構(gòu)的用途 數(shù)據(jù)結(jié)構(gòu)定義:用實際的編程語言定義該數(shù)據(jù)結(jié)構(gòu)數(shù)據(jù)項描述:數(shù)據(jù)類型數(shù)據(jù)項定義數(shù)據(jù)項描述3. Structure 2 結(jié)構(gòu)22.1.2 Function Description 函數(shù)描述This section should follow the format below:Identification: Title of the moduleType: Type of the module, for example, the module in Level 2 Design, the process in Level 1 Design, et

12、c.Function Description: Describing the functions of the module in brief, which should be consistent with the related section in HLD documents Function Invoking Relation: Using the Hierarchy Chart or Structure Chart to describe it, for example:本節(jié)應(yīng)按照下列格式進(jìn)行描述:標(biāo)識:模塊名稱類型:模塊類型,如,2級設(shè)計中的模塊,1級 設(shè)計中的進(jìn)程功能概述簡要描述

13、本模塊功能,要和概要設(shè)計文檔中相關(guān)模塊分解的描述一致。函數(shù)調(diào)用關(guān)系:用層次圖或結(jié)構(gòu)圖的方式描述函數(shù)調(diào)用關(guān)系,如:Figure 1 Module 1 St rue ture Char t 模塊 1 結(jié)構(gòu)圖1. Function 1 函數(shù) 1Descript the function as follows; Function:/ name of functionDescription:/ functionality of thefunctionCalls:/ function lists whichcalled by this functionData Accessed: / global var

14、iables or database tables to be visitedData Updated: / global variables ordatabase tables to be modifiedInput:/ description of eachinput parameter,/ including function description、value description,/and relationships of the parametersOutput:/ description of outputparameterReturn:/ description of ret

15、urnvalueOthers:/ other descriptionsFunction:pseudoImplement:code or flow chart can be used here函數(shù)名稱Description:/函數(shù)功能、性能等的描述Calls:/被本函數(shù)調(diào)用的函數(shù)清單Data Accessed: /被訪問的全局變量和數(shù)據(jù)庫表Data Updated:/被修改的全局變量和數(shù)據(jù)庫表Input:/輸入?yún)?shù)說明,包括每個參數(shù)的作用、取值說明及參數(shù)間關(guān)系。Output:/對輸出參數(shù)的說明。Return:/函數(shù)返回值的說明Others:其它說明實現(xiàn):這里可以使用偽碼或流程圖例子:m2ua r

16、eturn t m2ua nif sendto mtp2廣該函數(shù)重用原來MTP3模塊中提供的向MTP2發(fā)消息的函數(shù)if鏈路號不合法 返回M2UA_FAILURE,失敗if消息類型不正確返回M2UA_FAILURE , 失敗if參數(shù)指針為空返回M2UA_FAILURE ,失敗調(diào)用消息申請函數(shù)VOS_AHocMsg,為臨時 變量pMsg申請消息包空間if申請消息包失敗返回M2UA_FAILURE,消息申請函數(shù)填寫發(fā)送模塊信息到pMsg 調(diào)用設(shè)備管理的函數(shù)Dev_From VspCardNoGetCpuid,填寫目的板的CPUIDif調(diào)用失敗調(diào)用VOS_FreeMsg,釋放pMsg的消息包空間返回

17、M2UA_FAILURE,失敗填寫目的功能模塊號到pMsg 填上消息包的具體內(nèi)容 調(diào)用消息發(fā)送函數(shù)VOS_SendMsg, VOS把消息包發(fā)送到給MTP2返回 M2UA_SUCCESS,成功2. Function 2 函數(shù)22.2 Module 2 Datail Design 模塊2詳細(xì)設(shè)計2.3 Error Process 錯誤處理2.3.1 System Error 系統(tǒng)錯誤Describes how the errors, such as memory allocation failure, task creation failure, to be processed.描述象內(nèi)存分配失敗

18、,任務(wù)創(chuàng)建失敗等錯誤是如何被處理的。2.3.2 Interface Error 接口錯誤Describes the error codes to be generated for the external entities.描述將要產(chǎn)生并給外部實體用的錯誤碼2.3.3 Protocol Error 協(xié)議錯誤Describes how to handle the errors notmentioned in the protocols(Optional)描述在協(xié)議中沒有描述的情況如何處理。（可選）List of reference參考資料清單:Please list referred literature and relat