详细设计说明书(LLD模板)

1、XX Low Level Design SpecificationXX 详细设计说明书 Konka Research Institute康佳研究院Product version 产品版本Confidentiality level密级Project ID项目IDTotal pages：共12页XX Low Level Design SpecificationXX 详细设计说明书Prepared by 拟制Date日期yyyy-mm-ddReviewed by 评审人Date日期yyyy-mm-ddApproved by批准Date日期yyyy-mm-ddAuthorized by签发Date日期

2、yyyy-mm-ddKonka Research Institute康佳研究院All rights reserved版权所有 侵权必究Revision record 修订记录Date日期Revision version修订版本Description描述Author作者2001-06-081.00initial 初稿完成name 作者名yyyy-mm-dd1.01revised xxx 修改XXXname 作者名yyyy-mm-dd1.02revised xxx 修改XXXname 作者名yyyy-mm-dd2.00revised xxx 修改XXXname 作者名Distribution LI

3、ST 分发记录Copy No.Holder's Name & Role 持有者和角色Issue Date 分发日期1<PDT R&D Representative>yyyy-mm-dd2<Project Manager>yyyy-mm-dd3<Team members>yyyy-mm-dd4<Customer Representative>yyyy-mm-dd5<Others>yyyy-mm-ddCatalog 目 录1Introduction 简介61.1Purpose 目的61.2Scope 范围62Det

4、ailed Design 详细设计62.1Module 1 Detail Design 模块1详细设计62.1.1Data Description 数据描述62.1.1.1Simple Data Description 简单数据描述；62.1.1.2Structure 1 or Class 1 结构1或类172.1.1.3Structure 2 or Class 2 结构2或类272.1.2Function Description 函数描述82.1.2.1Function 1 函数182.1.2.2Function 2 函数29Table of contents for the table表目

5、录Table 1 XX 表1 XX6Table of contents for the figure图目录 Figure 1 XX 图 1 XX7XX Low Level Design SpecificationXX 详细设计说明书Keywords 关键词：能够体现文档描述内容主要方面的词汇。 Words that will reflect main contents of the document.Abstract 摘 要：List of abbreviations 缩略语清单：对本文所用缩略语进行说明，要求提供每个缩略语的英文全名和中文解释。 Describe abbreviations

6、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 sectio

7、n 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。.对于在概要

8、设计说明书中给出的软件实体，本节集中描述它们的详细描述部分。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

9、 数据描述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 modul

10、e;描述在本模块中定义和使用的简单变量、常量；2.1.1.2 Structure 1 or Class 1 结构1或类1define and describe the Data structure;定义和说明该数据结构；2.1.1.3 Structure 2 or Class 2 结构2或类22.1.2 Function Description 函数描述Describe the relationships of the functions within Module描述模块内函数的调用关系2.1.2.1 Function 1 函数1 Descript the function as follo

11、ws; 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 Upd

12、ated: / 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

13、 return value Others: / other descriptions-Implement: pseudocode or flow chart can be used here 用以下格式描述函数 Function: / 函数名称 Description: / 函数功能、性能等的描述 Calls: / 被本函数调用的函数清单 Called By: / 调用本函数的函数清单 Table Accessed: / 被访问的表（此项仅对于牵扯到数据库操作的程序） Table Updated: / 被修改的表（此项仅对于牵扯到数据库操作的程序） Input: / 输入参数说明，包括每个参数

14、的作用、取值说明及参数间关系。 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 H