xx模块_设计文档范文

《xx模块_设计文档范文》由会员上传分享，免费在线阅读，更多相关内容在应用文档-天天文库。

1、项目名称项目标识版本密级公开××模块详细设计拟制拟制时间评审评审时间批准批准时间签发签发时间单位名称：北京创原天地科技有限公司BeijingCreativeCenturyInformationTechnologyCo.,Ltd.版权所有，禁止翻印ccitDVP01-LowLevelDesign版本历史时间版本描述作者2003/11/071.00初稿张宝林分发记录序号角色姓名1开发经理2QA3SA4项目成员ConfidentialCCIT,2003Page7of7ccitDVP01-LowLevelDesign

2、目录1前言51.1目的51.2范围52详细设计52.1模块1详细设计52.1.1数据描述52.1.1.1简单数据描述52.1.1.2结构152.1.1.3结构262.1.2函数描述62.1.2.1函数162.1.2.2函数272.2模块2详细设计72.3错误处理72.3.1系统错误72.3.2接口错误72.3.3协议错误7ConfidentialCCIT,2003Page7of7ccitDVP01-LowLevelDesign关键词：摘要：缩略语：序号缩略语英文全拼中文参考资料：序号参考资料名称来源Confi

3、dentialCCIT,2003Page7of7ccitDVP01-LowLevelDesign1前言1.1目的本部分要求本文档的目的，一般详细设计应该能够直接指导编码，同时应该指明读者，说明本文档描述了哪个模块或子系统的详细设计。1.2范围本节描述文档包括和不包括的内容。2详细设计对于在概要设计说明书中给出的软件实体，本节集中描述它们的详细描述部分。2.1模块1详细设计描述在模块中定义和使用的数据，包括：简单数据，如模块级的全局变量、常量或宏。复杂数据，如模块内部的结构、联合。2.1.1数据描述在2.1.1

4、.1节描述本模块中的简单变量、常量或宏.在2.1.1.2中描述本模块中的复合数据，如结构、联合。2.1.1.1简单数据描述描述在本模块中定义和使用的简单变量、常量或者宏。按照下列格式进行简单数据的描述。功能描述：描述本数据的用途数据定义：定义该数据2.1.1.2结构1定义和说明该数据结构。按照下列格式进行数据结构的描述。数据结构描述：描述该数据结构的用途。数据结构定义：用实际的变成语言定义该数据结构。ConfidentialCCIT,2003Page7of7ccitDVP01-LowLevelDesign数据

5、项描述：数据类型数据项定义数据项描述1.1.1.1结构2……1.1.2函数描述本节按照下列格式进行描述。标识：模块标识类型：模块类型。如二级设计中的模块，一级设计中的进程。功能概述：简要描述本模块功能，要和概要设计中的相关模块分解的描述一致。函数调用关系，如：Function1Function2Function31.1.2.1函数1用下列格式描述函数Function：函数名称Description：函数功能描述Calls：被本函数调用的函数清单Called：调用本函数的函数清单DataAccessed：被访问

6、的全局变量和数据库表DataUpdated：被修改的全局变量和数据库表Input：输入参数说明，包括每个参数的作用，取值说明及参数间的关系Output：对输出参数的说明Return：函数返回值说明Other：其它说明—————————————————————————————————————实现：可以使用伪码或者流程图。ConfidentialCCIT,2003Page7of7ccitDVP01-LowLevelDesign1.1.1.1函数2……1.2模块2详细设计……1.3错误处理1.3.1系统错误描述内存

7、分配失败，任务创建失败等错误是如何处理的。1.3.2接口错误描述将要产生外部实体用的错误码。1.3.3协议错误描述在协议中没有描述的情况如何处理。ConfidentialCCIT,2003Page7of7