密级Confidentiality level
产品版Product version
Total 12pages 12页
XX Low Level Design Specification
XX 详细设计说明书
Prepared by
拟制
Name+ID
姓名+工号
Date
日期
yyyymmdd
Reviewed by
评审
Date
日期
yyyymmdd
Approved by
批准
Date
日期
yyyymmdd
XXXX Co Ltd
XXXX限公司
Revision Record 修订记录
Date
日期
Revision Version
修订
版
CR ID Defect ID
CR号
Sec No
修改
章节
Change Description
修改描述
Author
作者
1
1
Catalog 目 录
1 Introduction 简介 6
11 Purpose 目 6
12 Scope 范围 6
2 Detailed Design 详细设计 6
21 Module 1 Detail Design 模块1详细设计 6
211 Data Description 数描述 6
212 Function Description 函数描述 8
22 Module 2 Datail Design 模块2详细设计 11
23 Error Process 错误处理 11
231 System Error 系统错误 11
232 Interface Error 接口错误 11
233 Protocol Error 协议错误 11
Table List 表目录
Table1 **表 错误未定义书签
表1 **表 错误未定义书签
Figure List 图目录
Figure 1 Module 1 Structure Chart 模块1结构图 8
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 中文解释
1 Introduction 简介
11 Purpose 目
To descript the purpose of this document In general LLD specification can be used to guide the coding activities directly
描述文目般详细设计必须够直接指导编码活动
12 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
概设计说明书中出软件实体节集中描述详细描述部分
21 Module 1 Detail Design 模块1详细设计
Describe data that defined or used in the module including
simple data ie global variable constant or macro within the module
complex data ie Structure or union
描述模块中定义数包括:
简单数模块级全局变量常量宏
复合数模块部结构联合
211 Data Description 数描述
Describe simple variables constant or macro of the module in section 2111
Describe complex data from section 2112 such as structure union
2111中描述模块中简单变量常量宏
2112起描述模块中复合数结构联合等
1 Simple Data Description 简单数描述
describe simple variablesconstant 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
Data Type
Data Item Definition
Data Item Description
列格式进行数结构描述
数结构描述:描述该数结构途
数结构定义:实际编程语言定义该数结构
数项描述:
数类型
数项定义
数项描述
3 Structure 2 结构2
212 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 descriptionvalue 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_SendMsgVOS消息包发送MTP2
返回 M2UA_SUCCESS成功
2 Function 2 函数2
22 Module 2 Datail Design 模块2详细设计
23 Error Process 错误处理
231 System Error 系统错误
Describes how the errors such as memory allocation failure task creation failure to be processed
描述象存分配失败务创建失败等错误处理
232 Interface Error 接口错误
Describes the error codes to be generated for the external entities
描述产生外部实体错误码
233 Protocol 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 pp329330 February 1966 (英文文章格式)
[2] D Wolaver PhaseLocked Loop Circuit Design Prentice Hall New Jersey1991 (英文书籍格式)
[3] 王阳元奚雪梅等薄膜SOICMOS SPICE电路模拟电子学报vol22No51994 (中文文章格式)
[4] 郑筠MOS存储系统技术科学出版社1990 (中文书籍格式)
[5] XXXSDXXX户手册 V11基础部文档室2001426
文档容仅供参考
文档香网(httpswwwxiangdangnet)户传
《香当网》用户分享的内容,不代表《香当网》观点或立场,请自行判断内容的真实性和可靠性!
该内容是文档的文本内容,更好的格式请下载文档