详细设计说明书LLD模板.doc

详细设计说明书LLD模板

13
2020年4月19日
文档仅供参考，不当之处，请联系改正。

Konka Research Institute
康佳研究院

Product version
产品版本
Confidentiality level
密级

Project ID项目ID
Total pages：共12页

XX Low Level Design Specification
XX 详细设计说明书

Prepared by
拟制

Date
日期
yyyy-mm-dd
Reviewed by
评审人

Date
日期
yyyy-mm-dd
Approved by
批准

Date
日期
yyyy-mm-dd
Authorized by
签发

Date
日期
yyyy-mm-dd

Konka Research Institute
康佳研究院

All rights reserved
版权所有 侵权必究

Revision record 修订记录
Date
日期

Revision version
修订版本
Description
描述
Author
作者
-06-08
1.00
initial 初稿完成
name 作者名
yyyy-mm-dd
1.01
revised xxx 修改XXX
name 作者名
yyyy-mm-dd
1.02
revised xxx 修改XXX
name 作者名
……
……
……
……
yyyy-mm-dd
2.00
revised xxx 修改XXX
name 作者名

Distribution LIST 分发记录
Copy No.
Holder's Name & Role
持有者和角色
Issue Date
分发日期
1
<PDT R&D Representative>
yyyy-mm-dd
2
<Project Manager>
yyyy-mm-dd
3
<Team members>
yyyy-mm-dd
4
<Customer Representative>
yyyy-mm-dd
5
<Others>
yyyy-mm-dd

Catalog 目 录
1 Introduction 简介 6
1.1 Purpose 目的 6
1.2 Scope 范围 6
2 Detailed Design 详细设计 6
2.1 Module 1 Detail Design 模块1详细设计 6
2.1.1 Data Description 数据描述 6
2.1.1.1 Simple Data Description 简单数据描述； 6
2.1.1.2 Structure 1 or Class 1 结构1或类1 7
2.1.1.3 Structure 2 or Class 2 结构2或类2 7
2.1.2 Function Description 函数描述 8
2.1.2.1 Function 1 函数1 8
2.1.2.2 Function 2 函数2 9

Table of contents for the table表目录
Table 1 XX 表1 XX
6
Table of contents for the figure图目录
Figure 1 XX 图 1 XX
7

XX Low Level Design Specification
XX 详细设计说明书
Keywords 关键词：能够体现文档描述内容主要方面的词汇。 Words that will reflect main contents of the document.
Abstract 摘 要：
List of abbreviations 缩略语清单：对本文所用缩略语进行说明，要求提供每个缩略语的英文全名和中文解释。 Describe abbreviations in this document, full spelling of the abbreviation and Chinese explanation should be provided.

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 i.e. global variable or constant within the module;
complex data i.e. class or structure ....
描述模块中定义和使用的数据，包括：
简单数据，如模块级的全局变量、常量；
复合数据，如模块内部的类、结构，...；
2.1.1 Data Description 数据描述
describe simple variables and constant of the module in section 2.1.1.1;
describe complex data from section 2.1.1.2, such as class、structure;
在2.1.1.1中描述本模块中的简单变量、常量；
从2.1.1.2起描述本模块中的复合数据，如类、结构等；
2.1.1.1 Simple Data Description 简单数据描述；
describe simple variables、constant used or defined in this module;
描述在本模块中定义和使用的简单变量、常量；
2.1.1.2 Structure 1 or Class 1 结构1或类1
define and describe the Data structure;
定义和说明该数据结构；
2.1.1.3 Structure 2 or Class 2 结构2或类2

2.1.2 Function Description 函数描述
Describe the relationships of the functions within Module
描述模块内函数的调用关系
2.1.2.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
Called By: // function lists which call this funciton
Table Accessed: // tables to be visited
// (only for programm which involved with operation about database)
Table Updated: // tables to be modified
// (only for programm which involved with operation about database)
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: pseudocode or flow chart can be used here

用以下格式描述函数
Function: // 函数名称
Description: // 函数功能、性能等的描述
Calls: // 被本函数调用的函数清单
Called By: // 调用本函数的函数清单
Table Accessed: // 被访问的表（此项仅对于牵扯到数据库操作的程序）
Table Updated: // 被修改的表（此项仅对于牵扯到数据库操作的程序）
Input: // 输入参数说明，包括每个参数的作用、取值说明及参数间关系。
Output: // 对输出参数的说明。
Return: // 函数返回值的说明
Others: // 其它说明
----------------------------------------------------------------------------------------------------
实现： 这里能够使用伪码或流程图

2.1.2.2 Function 2 函数2
参考资料清单：
请罗列本文档所参考的有关参考文献和相关文档，格式如下：
作者＋书名（或杂志、文献、文档）＋出版社（或期号、卷号、公司文档编号）＋出版日期+起止页码
例如：
[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，基础部文档室， /4/26