实用软件详细设计文档.docx
《实用软件详细设计文档.docx》由会员分享，可在线阅读，更多相关《实用软件详细设计文档.docx（9页珍藏版）》请在冰点文库上搜索。
实用软件详细设计文档
XXLowLevelDesignSpecification
XX详细设计说明书
Preparedby
拟制
Name+ID
姓名+工号
Date
日期
yyyy-mm-dd
Reviewedby
评审人
Date
日期
yyyy-mm-dd
Approvedby
批准
Date
日期
yyyy-mm-dd
XXXXCo.,Ltd.
XXXX有限公司
RevisionRecord修订记录
Date
日期
RevisionVersion
修订
版本
CRID/DefectID
CR号
SecNo.
修改
章节
ChangeDescription
修改描述
Author
作者
1.
1.
Catalog目录
1Introduction简介6
1.1Purpose目的6
1.2Scope范围6
2DetailedDesign详细设计6
2.1Module1DetailDesign模块1详细设计6
2.1.1DataDescription数据描述6
2.1.2FunctionDescription函数描述8
2.2Module2DatailDesign模块2详细设计11
2.3ErrorProcess错误处理11
2.3.1SystemError系统错误11
2.3.2InterfaceError接口错误11
2.3.3ProtocolError协议错误11
TableList表目录
Table1**表错误！
未定义书签。
表1**表错误！
未定义书签。
FigureList图目录
Figure1Module1StructureChart模块1结构图8
XXLowLevelDesignSpecification
XX详细设计说明书
Keywords关键词：
Abstract摘要：
Listofabbreviations缩略语清单：
<对本文所用缩略语进行说明，要求提供每个缩略语的英文全名和中文解释。
Describeabbreviationsinthisdocument,fullspellingoftheabbreviationandChineseexplanationshouldbeprovided.>
Abbreviations缩略语
Fullspelling英文全名
Chineseexplanation中文解释
1
Introduction简介
1.1Purpose目的
Todescriptthepurposeofthisdocument.Ingeneral,LLDspecificationcanbeusedtoguidethecodingactivitiesdirectly.
描述本文的目的，一般详细设计必须能够直接指导编码活动。
1.2Scope范围
Thissectionshouldaddressareaswhichthisdocumentincludesandthatarespecificallyexcludes.
本节应描述文档所包括和不包括的内容。
2DetailedDesign详细设计
ThissectionshouldfocusonthedescriptionofthedetaileddesignofthesoftwareentitiesthatareapartofthesoftwarebeingdescribedbytheHLDSpecification。
.
对于在概要设计说明书中给出的软件实体，本节集中描述它们的详细描述部分。
2.1Module1DetailDesign模块1详细设计
Describedatathatdefinedorusedinthemodule,including:
simpledatai.e.globalvariable,constantormacrowithinthemodule;
complexdatai.e.Structureorunion....
描述模块中定义和使用的数据，包括：
简单数据，如模块级的全局变量、常量、宏；
复合数据，如模块内部的结构、联合...；
2.1.1DataDescription数据描述
Describesimplevariables,constantormacroofthemoduleinsection2.1.1.1;
Describecomplexdatafromsection2.1.1.2,suchasstructure,union;
在2.1.1.1中描述本模块中的简单变量、常量、宏；
从2.1.1.2起描述本模块中的复合数据，如结构、联合等；
1.SimpleDataDescription简单数据描述
describesimplevariables、constantormacrousedordefinedinthismodule;
描述在本模块中定义和使用的简单变量、常量、宏；
Describessimplevariables,constantsusedordefinedinthismodule;
Thedescriptionofsimpledatashouldfollowtheformatbelow:
FunctionDescription:
Describingtheusageofthedata
DataDefinition:
Definingthedata
按照下列格式进行简单数据的描述
功能描述：
描述该数据的用途
数据定义：
定义该数据
2.Structure1结构1
DefineanddescribetheDatastructure（includeunion）
定义和说明该数据结构（包括联合）;
Thedescriptionofdatastructureshouldfollowtheformatbelow:
DataStructureDescription:
Describingtheusageofthedatastructure
DataStructureDefinition:
Definingthedatastructurewiththeactualprograminglanguage
DataItemsDescription:
DataType
DataItemDefinition
DataItemDescription
按照下列格式进行数据结构的描述
数据结构描述：
描述该数据结构的用途
数据结构定义：
用实际的编程语言定义该数据结构
数据项描述：
数据类型
数据项定义
数据项描述
3.Structure2结构2
2.1.2
FunctionDescription函数描述
Thissectionshouldfollowtheformatbelow:
Identification:
Titleofthemodule
Type:
Typeofthemodule,forexample,themoduleinLevel2Design,theprocessinLevel1Design,etc.
FunctionDescription:
Describingthefunctionsofthemoduleinbrief,whichshouldbeconsistentwiththerelatedsectioninHLDdocuments.
FunctionInvokingRelation:
UsingtheHierarchyChartorStructureCharttodescribeit,forexample:
本节应按照下列格式进行描述：
标识：
模块名称
类型：
模块类型，如，2级设计中的模块，1级设计中的进程
功能概述：
简要描述本模块功能，要和概要设计文档中相关模块分解的描述一致。
函数调用关系:
用层次图或结构图的方式描述函数调用关系，如：
Figure1Module1StructureChart模块1结构图
1.Function1函数1
Descriptthefunctionasfollows;
Function:
//nameoffunction
Description:
//functionalityofthefunction
Calls:
//functionlistswhichcalledbythisfunction
DataAccessed:
//globalvariablesordatabasetablestobevisited
DataUpdated:
//globalvariablesordatabasetablestobemodified
Input:
//descriptionofeachinputparameter,
//includingfunctiondescription、valuedescription，
//andrelationshipsoftheparameters
Output:
//descriptionofoutputparameter
Return:
//descriptionofreturnvalue
Others:
//otherdescriptions
----------------------------------------------------------------------------------------------------
Implement:
pseudocodeorflowchartcanbeusedhere
用以下格式描述函数
Function:
//函数名称
Description:
//函数功能、性能等的描述
Calls:
//被本函数调用的函数清单
DataAccessed:
//被访问的全局变量和数据库表
DataUpdated:
//被修改的全局变量和数据库表
Input:
//输入参数说明，包括每个参数的作用、取值说明及参数间关系。
Output:
//对输出参数的说明。
Return:
//函数返回值的说明
Others:
//其它说明
----------------------------------------------------------------------------------------------------
实现：
这里可以使用伪码或流程图
例子:
m2ua_return_tm2ua_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.Function2函数2
2.2
Module2DatailDesign模块2详细设计
2.3ErrorProcess错误处理
2.3.1SystemError系统错误
Describeshowtheerrors,suchasmemoryallocationfailure,taskcreationfailure,tobeprocessed.
描述象内存分配失败，任务创建失败等错误是如何被处理的。
2.3.2InterfaceError接口错误
Describestheerrorcodestobegeneratedfortheexternalentities.
描述将要产生并给外部实体用的错误码
2.3.3ProtocolError协议错误
Describeshowtohandletheerrorsnotmentionedintheprotocols.（Optional）
描述在协议中没有描述的情况如何处理。
（可选）
Listofreference参考资料清单：
Pleaselistreferredliteratureandrelateddocuments,format:
请罗列本文档所参考的有关参考文献和相关文档，格式如下：
Author+bookname（ormagazine,literature,document）+publishingcompany（orissueNo.,volumeNo.,internaldocumentationID）+publishingdate+startandendpagenumber,
作者＋书名（或杂志、文献、文档）＋出版社（或期号、卷号、公司文档编号）＋出版日期+起止页码
examples:
例如：
[1]D.B.Leeson,“ASimpleModelofFeedbackOscillatorNoiseSpectrum,”Proc.IEEE,pp329-330,February1966（英文文章格式）
[2]D.Wolaver,Phase-LockedLoopCircuitDesign,PrenticeHall,NewJersey,1991（英文书籍格式）
[3]王阳元，奚雪梅等，“薄膜SOI/CMOSSPICE电路模拟”，电子学报，vol.22，No.5，1994（中文文章格式）
[4]郑筠，《MOS存储系统及技术》，科学出版社，1990（中文书籍格式）
[5]XXX，SDXXX用户手册V1.1，基础部文档室，2001/4/26
升级会员 