项目管理PMP资料-6.3 详细设计说明书

DOCPROPERTY"userfullname"某企业全称DOCPROPERTY"proposalname"详细设计说明书企业全称TIME\@"yyyy'年'M'月'd'日'"2019年5月7日 DOCPROPERTY"proposalname"详细设计说明书 第详细设计说明书文档副标题文档版本0.1文档日期文档状态草案作者文档变更版本修订日期修订人描述文档送呈姓名目的

目录TOC\o"1-3"\h\z1 引言 41.1 编写目的 41.2 范围 41.3 术语 41.4 参考资料 51.5 约定 52 模块设计 62.1 模块1 62.1.1 描述 62.1.2 用户界面 62.1.3 类设计 62.1.4 处理流程 72.1.5 关联模块 72.1.6 其他程序设计 72.1.7 相关的数据表 82.2 模块2 83 接口设计 94 配置文件说明 105 非功能性需求设计 116 附录 127 图表目录 13引言编写目的［编写说明］简要地说明设计的目的。范围［编写说明］简要说明本系统的实现细节，不包括概要设计部分,也不包括系统中硬件的设计。例如：1. 细化模块的详细划分。2. 确定系统的命名规则（模块、类、方法等），确保系统的设计风格与代码的风格一致。3. 定义模块间接口方法命名标准、入参格式、返回格式。4. 规定编码规范及其他设计约束。5. 确定底层类实现所采用的技术框架。6. 确定选取表现层的技术，及其展示的统一风格。…指明本文档的读者。术语［编写说明］列出本文件中用到的专门术语的定义和缩写词的原词组及说明。可以援引概要设计说明书中的相关说明，或省略。缩写、术语说明参考资料［编写说明］列出编写本说明书时参考的文件(如经核准的工作任务说明书或合同等)、资料、技术标准，以及他们的作者、标题、编号、发布日期和出版单位。可以援引概要设计说明书中的相关说明，或省略。约定［编写说明］说明本文件中版式编排、特殊字体及标记等相关约定。模块设计［编写说明］对《概要设计说明书》所定义的每一个模块进行详细说明。模块1描述［编写说明］对模块进行描述，包括模块ID，模块名称（如文件名称等），实现的功能等。用户界面［编写说明］对有用户界面的模块，描绘模块的操作界面图，并进行界面单元功能描述。类设计［编写说明］如果本模块有类，说明为了实现本模块功能需要使用到的类的描述。类图［编写说明］图示本模块及相关模块的类图。 类1（名称）1. 属性1：名称及描述2. 属性2：名称及描述3. …4. 方法1：名称、功能描述、参数描述、返回值描述、方法结构、方法算法描述5. 方法26. …类2参照类1方式进行描述。处理流程［编写说明］采用流程图（时序图、协作图等）、文字、表格等形式描述模块的全部处理流程，说明相关的数据流，条件，入口和出口等信息。关联模块［编写说明］说明为了实现本功能需要调用的其它模块、类或方法。其他程序设计［编写说明］如果本模块有诸如脚本语言等程序设计，参照如下方式描述。［裁剪说明］根据项目实际情况，可以裁剪。程序之间的关系［编写说明］可以以图示、表格、文字等形式说明程序之间及与相关类的关系。程序11. 程序名称2. 功能描述3. 算法描述 程序2［编写说明］参照程序的方式进行描述。相关的数据表［编写说明］本模块如引用数据表说明相关数据表的名称等信息。本模块如引用存储过程、视图等数据库对象及其他数据结构等，可以参照数据表的描述方式进行描述。模块2参照模块1的方式进行编写，以此类推。接口设计［编写说明］对《概要设计说明书》中定义的接口进行细化，接口描述应包含以下一些内容：1. 用途说明接口的功能。2. 输入说明调用该接口需要输入哪些数据。3. 参数、数据格式说明调用本接口需要的参数，并详细描述参数的具体格式。4. 通讯协议指出采用的通讯协议。5. 输出说明调用本接口后的结果。6. 异常情况处理描述使用该项界面数据过程中，若出现异常情况的话，如何处置。配置文件说明［编写说明］本系统如有配置文件，描述配置文件格式和配置方法非功能性需求设计［编写说明］针对《概要设计说明书》中定义的非功能性需求，包括安全性、性能、日志、自管理等进行具体设计。附录图表目录附图目录TOC\h\z\t"附图标题"\c附图1. 附图