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

1、產(chǎn)品名稱Product name密級(jí) Co nfide ntiality level產(chǎn)品版本 Product versionTotal 14pages 共 14 頁(yè)XX Low Level Desig n Specificati onXX詳細(xì)設(shè)計(jì)說(shuō)明書Prepared byName+IDDateyyyy-mm-dd擬制姓名+工號(hào)日期Reviewed byDateyyyy-mm-dd評(píng)審人日期Approved byDateyyyy-mm-dd批準(zhǔn)日期XX Low Level Design SpecificationXX詳細(xì)設(shè)計(jì)說(shuō)明書Please input confidentiality lev

2、el請(qǐng)輸入密級(jí)XXXX Co., Ltd.XXXX有限公司Page 12 , Total 14 第 3 頁(yè)，共 14 頁(yè)Revision Record 修訂記錄Date日期Revisio nVersio n修訂 版本CR ID/DefectIDCR號(hào)SecNo.修改 早節(jié)Change Description修改描述Author作者1.1.XX Low Level Design SpecificationXX詳細(xì)設(shè)計(jì)說(shuō)明書Please input confidentiality level請(qǐng)輸入密級(jí)Catalog 目錄1 In troduct ion 簡(jiǎn)介 71.1 Purpose 目的 71.

3、2 Scope 范圍 72 Detailed Design 詳纟田設(shè)計(jì) 72.1 Module 1 Detail Design模塊 1 詳細(xì)設(shè)計(jì) 72.1.1 Data Description 數(shù)據(jù)描述 72.1.2 Function Description函數(shù)描述 1 02.2 Module 2 Datail Design模塊 2詳細(xì)設(shè)計(jì) 132.3 Error Process 錯(cuò)誤處理 132.3.1 System Error系統(tǒng)錯(cuò)誤 132.3.2 In terface Error 接口錯(cuò)誤 1 32.3.3 Protocol Error協(xié)議錯(cuò)誤 13Page # , Total 14

4、第4 頁(yè)，共 14 頁(yè)XX Low Level Design SpecificationPlease input confidentiality levelXX詳細(xì)設(shè)計(jì)說(shuō)明書請(qǐng)輸入密級(jí)Table List 表目錄Table1*表 錯(cuò)誤！未定義書簽。表1*表 錯(cuò)誤！未定義書簽。Figure List 圖目錄Figure 1 Module 1 Structure Chart 模塊 1 結(jié)構(gòu)圖 1 0Page 5 , Total 14 第 5 頁(yè)，共 14 頁(yè)XX Low Level Design SpecificationXX詳細(xì)設(shè)計(jì)說(shuō)明書Please input confidentiality

5、level請(qǐng)輸入密級(jí)XX Low Level Design SpecificationXX詳細(xì)設(shè)計(jì)說(shuō)明書Keywords 關(guān)鍵詞：Abstract 摘 要：List of abbreviatio ns縮略語(yǔ)清單：< 對(duì)本文所用縮略語(yǔ)進(jìn)行說(shuō)明，要求提供每個(gè)縮略語(yǔ)的英文全名和中文解釋。Describe abbreviations in this document, full spelling of theabbreviati on and Chin ese expla nati on should be provided.Abbreviatio ns 縮略語(yǔ)Full spelli ng 英文

6、全名Chin ese expla nati on中文解釋Page 12 , Total 14 第 # 頁(yè)，共 14 頁(yè)XX Low Level Design SpecificationXX詳細(xì)設(shè)計(jì)說(shuō)明書Please input confidentiality level請(qǐng)輸入密級(jí)1 Introduction 簡(jiǎn)介1.1 Purpose 目的To descript the purpose of this document. In general, LLD specification can be used toguide the codi ng activities directly.描述本文的

7、目的，一般詳細(xì)設(shè)計(jì)必須能夠直接指導(dǎo)編碼活動(dòng)。1.2 Scope 范圍This sect ion should address areas which this docume nt in cludes and that are specifically excludes.本節(jié)應(yīng)描述文檔所包括和不包括的內(nèi)容。2 Detailed Design 詳細(xì)設(shè)計(jì)This sect ion should focus on the descripti on of the detailed desig n of the software en tities that are a part of the softw

8、are being described by the HLD Specification。.對(duì)于在概要設(shè)計(jì)說(shuō)明書中給出的軟件實(shí)體，本節(jié)集中描述它們的詳細(xì)描述部分。2.1 Module 1 Detail Design 模塊 1 詳細(xì)設(shè)計(jì)Describe data that defi ned or used in the module, in cludi ng:simple data i.e. global variable, constant or macro within the module;complex data i.e. Structure or union.描述模塊中定義和使用的數(shù)據(jù)

9、，包括：簡(jiǎn)單數(shù)據(jù)，如模塊級(jí)的全局變量、常量、宏；復(fù)合數(shù)據(jù)，如模塊內(nèi)部的結(jié)構(gòu)、聯(lián)合.；2.1.1 Data Description 數(shù)據(jù)描述Describe simple variables, con sta nt or macro of the module in sect ion 2.1.1.1;Describe complex data from sect ion 2.1.1.2, such as structure, union;在2.1.1.1中描述本模塊中的簡(jiǎn)單變量、常量、宏；從2.1.1.2起描述本模塊中的復(fù)合數(shù)據(jù)，如結(jié)構(gòu)、聯(lián)合等；1. Simple Data Descriptio

10、n簡(jiǎn)單數(shù)據(jù)描述describe simple variables、constant or macro used or defined in this module;描述在本模塊中定義和使用的簡(jiǎn)單變量、常量、宏；Describes simple variables, con sta nts used or defi ned in this module;The description of simple data should follow the format below:Function Descripti on: Describ ing the usage of the dataData

11、Defin iti on: Defining the data按照下列格式進(jìn)行簡(jiǎn)單數(shù)據(jù)的描述功能描述：描述該數(shù)據(jù)的用途數(shù)據(jù)定義：定義該數(shù)據(jù)2. Structure 1 結(jié)構(gòu) 1Define and describe the Data structure (in clude union)定義和說(shuō)明該數(shù)據(jù)結(jié)構(gòu)(包括聯(lián)合);The description of data structure should follow the format below:Data Structure Description: Describing the usage of the data structureData

12、Structure Definition: Defining the data structure with the actual programing IanguageData Items Descripti on:Data TypeData Item Defin iti onData Item Descripti on按照下列格式進(jìn)行數(shù)據(jù)結(jié)構(gòu)的描述數(shù)據(jù)結(jié)構(gòu)描述：描述該數(shù)據(jù)結(jié)構(gòu)的用途數(shù)據(jù)結(jié)構(gòu)定義：用實(shí)際的編程語(yǔ)言定義該數(shù)據(jù)結(jié)構(gòu)數(shù)據(jù)項(xiàng)描述：數(shù)據(jù)類型數(shù)據(jù)項(xiàng)定義數(shù)據(jù)項(xiàng)描述3. Structure 2 結(jié)構(gòu) 2Page 12 , Total 14 第 9 頁(yè)，共 14 頁(yè)XX Low Level D

13、esign SpecificationPlease input confidentiality levelXX詳細(xì)設(shè)計(jì)說(shuō)明書請(qǐng)輸入密級(jí)2.1.2 Fu nction Description函數(shù)描述This sect ion 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 Desig n, etc.Function Descript

14、i on: Describ ing the functions of the module in brief, which should becon siste nt with the related sect ion in HLD docume nts.Function Invoking Relation: Using the Hierarchy Chart or Structure Chart to describe it, for example:本節(jié)應(yīng)按照下列格式進(jìn)行描述：標(biāo)識(shí)：模塊名稱類型：模塊類型，如，2級(jí)設(shè)計(jì)中的模塊，1級(jí)設(shè)計(jì)中的進(jìn)程功能概述：簡(jiǎn)要描述本模塊功能，要和概要設(shè)計(jì)文檔

15、中相關(guān)模塊分解的描述一致。函數(shù)調(diào)用關(guān)系：用層次圖或結(jié)構(gòu)圖的方式描述函數(shù)調(diào)用關(guān)系，如：Figure 1 Module 1 Structure Chart 模塊 1 結(jié)構(gòu)圖1. Function 1 函數(shù) 1Descript the fun cti on as follows;Fun cti on:/ n ame of functionDescripti on:/ fun cti on ality of the fun ctio nCalls:/ fun cti on lists which called by this fun cti onData Accessed: / global vari

16、ables or database tables to be visitedData Updated: / global variables or database tables to be modifiedIn put:/ description of each in put parameter,/including function description 、 value description ，/ and relati on ships of the parametersOutput:/ descripti on of output parameterReturn:/ descript

17、i on of retur n valueOthers:/ other descripti onsImpleme nt:pseudo code or flow chart can be used here用以下格式描述函數(shù)Fun cti on:/函數(shù)名稱Descripti on:/函數(shù)功能、性能等的描述Calls:/被本函數(shù)調(diào)用的函數(shù)清單Data Accessed: /被訪問(wèn)的全局變量和數(shù)據(jù)庫(kù)表Data Updated: /被修改的全局變量和數(shù)據(jù)庫(kù)表In put:/輸入?yún)?shù)說(shuō)明，包括每個(gè)參數(shù)的作用、取值說(shuō)明及參數(shù)間關(guān)系。Output:/對(duì)輸出參數(shù)的說(shuō)明。Return:/函數(shù)返回值的說(shuō)明Others:/其它說(shuō)明Page 11 , Total 14 第 13頁(yè)，共 14 頁(yè)實(shí)現(xiàn):這里可以使用偽碼或流程圖例子:m2ua_return_t m2ua_ ni 1_se ndto_mtp2/*該函數(shù)重用原來(lái)MTP3模塊中提供的向MTP2發(fā)消息的函數(shù)*/if鏈路號(hào)不合法 返回M2UA_FAILURE，失敗if消息類型不正確返回M2UA_FAILURE，失敗if參數(shù)指針為空 返回M2UA_FAILUR