华为软件详细设计模板.doc

1、产品名称Product name 密级 Confidentiality level产品版本 Product version Total 12pages 共12页XX Low Level Design SpecificationXX 详细设计说明书Prepared by 拟制Name+ID姓名+工号Date日期yyyy-mm-ddReviewed by 评审人Date日期yyyy-mm-ddApproved by批准Date日期yyyy-mm-ddXXXX Co., Ltd. XXXX有限公司XX Low Level Design SpecificationXX 详细设计说明书Please in

2、put confidentiality level 请输入密级Page 2 , Total 12 第2页，共12页 Revision Record 修订记录Date日期Revision Version修订版本CR ID / Defect IDCR号Sec No. 修改章节Change Description修改描述Author作者1.1.XX Low Level Design SpecificationXX 详细设计说明书Please input confidentiality level 请输入密级Page 3 , Total 12 第3页，共12页 Catalog 目 录1 Introdu

3、ction 简介 .61.1 Purpose 目的 .61.2 Scope 范围 .62 Detailed Design 详细设计 .62.1 Module 1 Detail Design 模块1详细设计 .62.1.1 Data Description 数据描述 .62.1.2 Function Description 函数描述 .82.2 Module 2 Datail Design 模块2详细设计 .112.3 Error Process 错误处理 .112.3.1 System Error 系统错误 .112.3.2 Interface Error 接口错误 .112.3.3 Prot

4、ocol Error 协议错误 .11XX Low Level Design SpecificationXX 详细设计说明书Please input confidentiality level 请输入密级Page 4 , Total 12 第4页，共12页 Table List 表目录Table1 *表 .错误！未定义书签。表1 *表 .错误！未定义书签。Figure List 图目录Figure 1 Module 1 Structure Chart 模块1结构图 .8XX Low Level Design SpecificationXX 详细设计说明书Please input confide

5、ntiality level 请输入密级Page 5 , Total 12 第5页，共12页 XX Low Level Design SpecificationXX 详细设计说明书Keywords 关键词：Abstract 摘 要：List of abbreviations 缩略语清单： Abbreviations缩略语 Full spelling 英文全名 Chinese explanation 中文解释XX Low Level Design SpecificationXX 详细设计说明书Please input confidentiality level 请输入密级Page 6 , Tot

6、al 12 第6页，共12页 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.描述本文的目的，一般详细设计必须能够直接指导编码活动。1.2 Scope 范围This section should address areas which this document includes and that are specifically ex

7、cludes. 本节应描述文档所包括和不包括的内容。2 Detailed Design 详细设计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。 .对于在概要设计说明书中给出的软件实体，本节集中描述它们的详细描述部分。2.1 Module 1 Detail Design 模块1详细设计Describe data t

8、hat defined or used in the module, including:simple data i.e. global variable, constant or macro within the module;complex data i.e. Structure or union.描述模块中定义和使用的数据，包括：简单数据，如模块级的全局变量、常量、宏；复合数据，如模块内部的结构、联合 .；2.1.1 Data Description 数据描述Describe simple variables, constant or macro of the module in sec

9、tion 2.1.1.1;Describe complex data from section 2.1.1.2, such as structure, union;在 2.1.1.1中描述本模块中的简单变量、常量、宏；从 2.1.1.2起描述本模块中的复合数据，如结构、联合等；1. Simple Data Description 简单数据描述describe simple variables、 constant or macro used or defined in this module;描述在本模块中定义和使用的简单变量、常量、宏；XX Low Level Design Specifica

10、tionXX 详细设计说明书Please input confidentiality level 请输入密级Page 7 , Total 12 第7页，共12页 Describes simple variables, constants used or defined 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

11、按照下列格式进行简单数据的描述功能描述：描述该数据的用途数据定义：定义该数据2. Structure 1 结构1Define and describe the Data structure (include union)定义和说明该数据结构 (包括联合 );The description of data structure should follow the format below:Data Structure Description: Describing the usage of the data structureData Structure Definition: Defining

12、the data structure with the actual programing languageData Items Description:Data Type Data Item Definition Data Item Description按照下列格式进行数据结构的描述数据结构描述：描述该数据结构的用途数据结构定义：用实际的编程语言定义该数据结构数据项描述：数据类型 数据项定义 数据项描述3. Structure 2 结构2XX Low Level Design SpecificationXX 详细设计说明书Please input confidentiality level

13、 请输入密级Page 8 , Total 12 第8页，共12页 2.1.2 Function Description 函数描述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, etc.Function Description: Describing the functions of the

14、 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:本节应按照下列格式进行描述：标识：模块名称类型：模块类型，如， 2级设计中的模块， 1级设计中的进程功能概述：简要描述本模块功能，要和概要设计文档中相关模块分解的描述一致。函数调用关系 : 用层次图或结构图的方式描述函数调用

15、关系，如： Function1Function2 Function3A,BC D,EFigure 1 Module 1 Structure Chart 模块1结构图1. Function 1 函数1Descript the function as follows;Function: / name of functionDescription: / functionality of the functionCalls: / function lists which called by this functionData Accessed: / global variables or databa

16、se tables to be visited Data Updated: / global variables or database tables to be modified Input: / description of each input parameter,/ including function description、 value description，/ and relationships of the parametersOutput: / description of output parameterReturn: / description of return va

17、lueXX Low Level Design SpecificationXX 详细设计说明书Please input confidentiality level 请输入密级Page 9 , Total 12 第9页，共12页 Others: / other descriptions-Implement: pseudo code or flow chart can be used here用以下格式描述函数 Function: / 函数名称Description: / 函数功能、性能等的描述Calls: / 被本函数调用的函数清单Data Accessed: / 被访问的全局变量和数据库表Dat

18、a Updated: / 被修改的全局变量和数据库表Input: / 输入参数说明，包括每个参数的作用、取值说明及参数间关系。Output: / 对输出参数的说明。Return: / 函数返回值的说明Others: / 其它说明-实现： 这里可以使用伪码或流程图例子 :m2ua_return_t m2ua_nif_sendto_mtp2/*该函数重用原来 MTP3模块中提供的向 MTP2发消息的函数 */if 链路号不合法 返回 M2UA_FAILURE，失败if 消息类型不正确 返回 M2UA_FAILURE ，失败if 参数指针为空 返回 M2UA_FAILURE ，失败调用 消息申请函数

19、 VOS_AllocMsg，为临时变量 pMsg申请消息包空间if 申请消息包失败 返回 M2UA_FAILURE，消息申请函数填写发送模块信息到 pMsg调用 设备管理的函数 Dev_FromVspCardNoGetCpuid，填写目的板的 CPUIDif 调用失败调用 VOS_FreeMsg，释放 pMsg的消息包空间返回 M2UA_FAILURE，失败填写目的功能模块号到 pMsg填上消息包的具体内容调用 消息发送函数 VOS_SendMsg， VOS把消息包发送到给 MTP2返回 M2UA_SUCCESS，成功XX Low Level Design SpecificationXX 详细设计说明书Please input confidentiality level 请输入密级Page 10 , Total 12 第10页，共12页 2. Function 2 函数2