06项目开发(rnd)详细设计说明书.docx

详细设计说明书文档属性属性内容客户名称某企业全称user full name项目名称项目全称 project full name文档主题详细设计说明书文档副标题文档版本0.1文档日期文档状态草案作者文档变更版本修订日期修订人描述4配置文件说明编写说明本系统如有配置文件，描述配置文件格式和配置方法5非功能性需求设计编写说明针对概要设计说明书中定义的非功能性需求，包括安全性、性能、日志、自管理等 进行具体设计。6附录7图表目录附图目录附图i.附图附图2.附图错误!未定义书签。错误!未定义书签。表格目录表格1.表格表格2.表格错误!未定义书签。错误!未定义书签。文档送呈姓名目的1 引言41.1 编写目的41.2 范围41.3 术语41.4 参考资料51.5 约定5模块设计61.6 模块16描述61.6.1 用户界面6类设计61.6.2 处理流程7关联模块71.6.3 其他程序设计7相关的数据表81.7 模块28接口设计92 配置文件说明10非功能性需求设计113 附录12图表目录131引言编写目的编写说明简要地说明设计的目的。1.1 范编写说明简要说明本系统的实现细节，不包括概要设计部分，也不包括系统中硬件的设计。例如:1 .细化模块的详细划分。2 .确定系统的命名规则（模块、类、方法等），确保系统的设计风格与代码的风格一 致。3 .定义模块间接口方法命名标准、入参格式、返回格式。4 .规定编码规范及其他设计约束。5 .确定底层类实现所采用的技术框架。6 .确定选取表现层的技术，及其展示的统一风格。 指明本文档的读者。1.3 术语编写说明列出本文件中用到的专门术语的定义和缩写词的原词组及说明。可以援引概要设计说明 书中的相关说明，或省略。说明缩写、术语参考资料编写说明列出编写本说明书时参考的文件（如经核准的工作任务说明书或合同等）、资料、技术标 准，以及他们的作者、标题、编号、发布日期和出版单位。可以援引概要设计说明书中的相 关说明，或省略。1.4 约定编写说明说明本文件中版式编排、特殊字体及标记等相关约定。2模块设计编写说明对概要设计说明书所定义的每一个模块进行详细说明。2.1 模块1描述编写说明对模块进行描述，包括模块ID,模块名称（如文件名称等），实现的功能等。2.1.1 用户界面编写说明对有用户界面的模块，描绘模块的操作界面图，并进行界面单元功能描述。2.1,3类设计编写说明如果本模块有类，说明为了实现本模块功能需要使用到的类的描述。2.1.3.1 类图编写说明图示本模块及相关模块的类图。2.1.3.2 类 1 （名称）1 .属性1：名称及描述2 .属性2：名称及描述3.4 .方法1：名称、功能描述、参数描述、返回值描述、方法结构、方法算法描述5 .方法26 .2.1.3.3 类 2参照类1方式进行描述。2J.4处理流程编写说明采用流程图（时序图、协作图等）、文字、表格等形式描述模块的全部处理流程，说明 相关的数据流，条件，入口和出口等信息。2.1.5 关联模块编写说明说明为了实现本功能需要调用的其它模块、类或方法。2.1.6 其他程序设计编写说明如果本模块有诸如脚本语言等程序设计，参照如下方式描述。裁剪说明根据项目实际情况，可以裁剪。2.1.6.1 程序之间的关系编写说明可以以图示、表格、文字等形式说明程序之间及与相关类的关系。2.1.6.2 程序 1i.程序名称2 .功能描述3 .算法描述2.1.6.3 程序 2编写说明参照程序的方式进行描述。相关的数据表编写说明本模块如引用数据表说明相关数据表的名称等信息。本模块如引用存储过程、视图等数 据库对象及其他数据结构等，可以参照数据表的描述方式进行描述。2.2模块2参照模块1的方式进行编写，以此类推。3接口设计编写说明对概要设计说明书中定义的接口进行细化，接口描述应包含以下一些内容:1 .用途说明接口的功能。2 .输入说明调用该接口需要输入哪些数据。3 .参数、数据格式说明调用本接口需要的参数，并详细描述参数的具体格式。4 .通讯协议指出采用的通讯协议。5 .输出说明调用本接口后的结果。6 .异常情况处理描述使用该项界面数据过程中，若出现异常情况的话，如何处置。