产品名称Product name
产品版本Product version
密级Confidentiality level
Total 12pages 共12页
XX Low Level Design Specification
XX 详细设计说明书
Prepared by
拟制
Reviewed by
评审人
Approved by
批准
Name+ID
姓名+工号
Date
日期
Date
日期
Date
日期
yyyy-mm-dd
yyyy-mm-dd
yyyy-mm-dd
XXXX Co., Ltd.
XXXX有限公司
XX Low Level Design Specification
XX 详细设计说明书
Please input confidentiality level
请输入密级
Revision Record 修订记录
Date
日期
Revisio
CR ID
/
Defec
t ID
CR号
n
Version
修订
版本
Change Description
修改描述
Author
作者
Sec
No.
修改
章节
1.
1.
Page 2 , Total 12 第2页,共12页
XX Low Level Design Specification
XX 详细设计说明书
Please input confidentiality level
请输入密级
Catalog 目 录
Introduction 简介 ...................................................................................................................... 6
1
Purpose 目的 ......................................................................................................................6
1.1
Scope 范围 ......................................................................................................................... 6
1.2
2 Detailed Design 详细设计 ......................................................................................................... 6
2.1 Module 1 Detail Design 模块1详细设计 ..............................................................................6
Data Description 数据描述 ........................................................................................... 6
Function Description 函数描述 .....................................................................................8
2.2 Module 2 Datail Design 模块2详细设计 ............................................................................11
Error Process 错误处理 .....................................................................................................11
2.3
System Error 系统错误 ................................................................................................11
Interface Error 接口错误 ..............................................................................................11
Protocol Error 协议错误 ...............................................................................................11
2.3.1
2.3.2
2.3.3
2.1.1
2.1.2
Page 3 , Total 12 第3页,共12页
XX Low Level Design Specification
XX 详细设计说明书
Please input confidentiality level
请输入密级
Table List 表目录
Table1
表1
**表 ................................................................................................. 错误!未定义书签。
**表 ....................................................................................................... 错误!未定义书签。
Figure List 图目录
Figure 1 Module 1 Structure Chart 模块1结构图 ........................................................................ 8
Page 4 , Total 12 第4页,共12页
XX Low Level Design Specification
XX 详细设计说明书
Please input confidentiality level
请输入密级
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.>
Abbreviations缩略语
Full spelling 英文全名
Chinese explanation 中文解释
Page 5 , Total 12 第5页,共12页
XX Low Level Design Specification
XX 详细设计说明书
Please input confidentiality level
请输入密级
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
excludes.
本节应描述文档所包括和不包括的内容。
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 that defined or used in the module, including:
simple data
complex data i.e. Structure or union....
描述模块中定义和使用的数据,包括:
i.e. global variable, constant or macro within the module;
简单数据,如模块级的全局变量、常量、宏;
复合数据,如模块内部的结构、联合...;
2.1.1
Data 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;
描述在本模块中定义和使用的简单变量、常量、宏;
Page 6 , Total 12 第6页,共12页
XX Low Level Design Specification
XX 详细设计说明书
Please input confidentiality level
请输入密级
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:
Data Type
Data Item Definition
Data Item Description
按照下列格式进行数据结构的描述
数据结构描述:描述该数据结构的用途
数据结构定义:用实际的编程语言定义该数据结构
数据项描述:
数据类型
数据项定义
数据项描述
3. Structure 2 结构2
Page 7 , Total 12 第7页,共12页
XX Low Level Design Specification
XX 详细设计说明书
Please input confidentiality level
请输入密级
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级设计中的进程
功能概述:简要描述本模块功能,要和概要设计文档中相关模块分解的描述一致。
函数调用关系: 用层次图或结构图的方式描述函数调用关系,如:
Function1
A,B
C
D,E
Function2
Function3
Figure 1
Module 1 Structure Chart 模块1结构图
1. Function 1 函数1
Descript the function as follows;
// name of function
Function:
Description:
// functionality of the function
Calls:
Data Accessed: // global variables or database tables to be visited
Data Updated:
Input:
// function lists which called by this function
// global variables or database tables to be modified
// description of each input parameter,
// including function description、value description,
// and relationships of the parameters
// description of output parameter
// description of return value
Output:
Return:
Page 8 , Total 12 第8页,共12页