华为软件详细设计详细说明书模板

XX 详细设计说明书

Prepared by 

XXXX有限公司

Revision Record 修订记录

Date

Table List 表目录

Figure List 图目录

XX Low Level Design Specification

XX 详细设计说明书

Keywords 关键词：

Abstract  摘    要：

List of abbreviations 缩略语清单：<对本文所用缩略语进行说明，要求提供每个缩略语的英文全名和中文解释。Describe abbreviations in this document, full spelling of the abbreviation and Chinese explanation should be provided.> 

Introduction  简介

1.1Purpose  目的

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 excludes. 

本节应描述文档所包括和不包括的内容。

2Detailed 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 that 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.1Data  Description 数据描述

Describe simple variables, constant or macro of the module in section 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;

描述在本模块中定义和使用的简单变量、常量、宏；

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 data

Data Definition: Defining the data

按照下列格式进行简单数据的描述

功能描述：描述该数据的用途

数据定义：定义该数据

2.Structure 1  结构1

Define 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 structure

Data Structure Definition: Defining the data structure with the actual programing language

Data Items Description:

数据结构描述：描述该数据结构的用途

数据结构定义：用实际的编程语言定义该数据结构

数据项描述：

2.1.2

Function Description  函数描述

This section should follow the format below:

Identification: Title of the module

Type: 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 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级设计中的进程

功能概述：简要描述本模块功能，要和概要设计文档中相关模块分解的描述一致。

函数调用关系: 用层次图或结构图的方式描述函数调用关系，如：

Figure 1 Module 1 Structure Chart 模块1结构图

1.Function 1 函数1

   Descript the function as follows;

   Function:       // name of function

  Description:    // functionality of the function

  Calls:          // function lists which called by this function

  Data Accessed: // global variables or database 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 parameters

  Output:         // description of output parameter

  Return:         // description of return value

  Others:         //  other descriptions

----------------------------------------------------------------------------------------------------

Implement:                    pseudo code or flow chart can be used here

   用以下格式描述函数 

   Function:       // 函数名称

  Description:    // 函数功能、性能等的描述

  Calls:          // 被本函数调用的函数清单

  Data Accessed: // 被访问的全局变量和数据库表

  Data Updated:  // 被修改的全局变量和数据库表

  Input:          // 输入参数说明，包括每个参数的作用、取值说明及参数间关系。

  Output:         // 对输出参数的说明。

  Return:         // 函数返回值的说明

  Others:         // 其它说明

----------------------------------------------------------------------------------------------------

实现：                             这里可以使用伪码或流程图

例子:

m2ua_return_t m2ua_nif_sendto_mtp2

/*该函数重用原来MTP3模块中提供的向MTP2发消息的函数*/

if 链路号不合法 返回  M2UA_FAILURE，失败

if 消息类型不正确 返回  M2UA_FAILURE ，失败

if 参数指针为空 返回  M2UA_FAILURE ，失败

调用  消息申请函数VOS_AllocMsg，为临时变量pMsg申请消息包空间

if 申请消息包失败 返回  M2UA_FAILURE，消息申请函数

填写发送模块信息到pMsg

调用 设备管理的函数Dev_FromVspCardNoGetCpuid，填写目的板的CPUID

if 调用失败

        调用 VOS_FreeMsg，释放pMsg的消息包空间

        返回 M2UA_FAILURE，失败

填写目的功能模块号到pMsg

填上消息包的具体内容

调用 消息发送函数VOS_SendMsg，VOS把消息包发送到给MTP2

返回  M2UA_SUCCESS，成功

2.Function 2 函数2

2.2

Module 2 Datail Design 模块2详细设计

2.3Error Process 错误处理

2.3.1System Error 系统错误

Describes how the errors, such as memory allocation failure, task creation failure, to be processed.

描述象内存分配失败，任务创建失败等错误是如何被处理的。

2.3.2Interface Error 接口错误

Describes the error codes to be generated for the external entities.

描述将要产生并给外部实体用的错误码

2.3.3Protocol Error 协议错误

Describes how to handle the errors not mentioned in the protocols. (Optional)

描述在协议中没有描述的情况如何处理。（可选）

List of reference 参考资料清单：

Please list referred literature and related documents, format:

请罗列本文档所参考的有关参考文献和相关文档，格式如下：

Author + book name (or magazine, literature, document) + publishing company (or issue No., volume No., internal documentation ID) + publishing date + start and end page number,

作者＋书名（或杂志、文献、文档）＋出版社（或期号、卷号、公司文档编号）＋出版日期+起止页码

examples:

例如：

[1]D. B. Leeson, “A Simple Model of Feedback Oscillator Noise Spectrum,” Proc. IEEE, pp329-330, February 1966 （英文文章格式）

[2]D. Wolaver, Phase-Locked Loop Circuit Design, Prentice Hall, New Jersey,1991  （英文书籍格式）

[3]王阳元，奚雪梅等，“薄膜SOI/CMOS SPICE电路模拟”，电子学报，vol.22，No.5，1994  （中文文章格式）

[4]郑筠，《MOS存储系统及技术》，科学出版社，1990  （中文书籍格式）

[5]XXX，SDXXX用户手册 V1.1，基础部文档室，2001/4/26