详细设计说明书模版

密级：机密文档编号：XXX_TS_TEMP_XXSJSMS版本号：V2.0【项目名称】详细设计说明书模板编写人：XXX批准人：XXX生效日期：2017年1月6日版权信息本文件涉及之信息，属XXX所有。未经XXX允许，文件中的任何部分都不能以任何形式向第三方散发。文档修订记录版本号修订日期修订人修订说明修订状态审核日期审核人批准人V0.12016-12-1XXX创建A2016-12-1XXXXXXV1.02016-12-28XXX调整需求分析方法M2016-12-29XXXXXXV2.02017-1-4XXX更换使用模板M2017-1-6XXXXXX修订状态：A--增加，M--修改，D--删除日期格式：YYYY-MM-DD目录1概述...........................................11.1编写目的....................................11.2适用范围....................................11.3术语和缩写..................................11.4参考资料....................................12角色和职责.....................................23设计约定.......................................34实现架构及功能逻辑.............................34.1功能逻辑描述................................34.1.1功能模块结构图..............................34.1.2功能模块描述................................44.2软件体系架构................................54.2.1设计思路....................................64.2.2包图及描述..................................64.2.3类图及描述..................................74.2.4主要程序描述................................84.2.5组件图及描述................................94.2.6源代码目录结构..............................94.2.7权限设计...................................104.3总体界面设计...............................104.3.1设计原则...................................104.3.2设计思路...................................104.3.3界面风格...................................104.3.4界面层次图.................................114.3.5界面原型...................................115详细设计......................................115.1模块A......................................125.1.1概要说明...................................125.2.2实现框架...................................135.3.3主要逻辑实现描述：..........................145.3.4界面设计...................................185.3.5接口设计...................................185.3.6其它.......................................185.2模块B......................................186数据库设计....................................187接口设计......................................198附录：........................................191概述1.1编写目的此处填写本文档的目的例如：XXX项目的目的是：根据《XXX需求规格说明书》进行详细设计1.2适用范围此处填写本文档的适用范围等1.3术语和缩写此处填写本文档中所特有的术语和缩写，常用的术语和缩写统一编写在一个规范文档中术语和缩写解释备注1.4参考资料指出为完成本文档所需要的参考资料，包括a属于本项目的其它已发表的文件；b本文件中各处引用到的文件资料，包括所要用到的软件开发标准。列出这些文件的标题、文件编号、发表日期和出版单位，说明能够取得这些文件的来源。参考文件备注《XXXX项目需求规格说明书》《XXXX项目系统概要设计报告》2角色和职责角色职责项目经理指导和审查数据库的详细设计系统分析员负责数据库的详细设计3设计约定说明系统设计需要遵循的一些约定和约束等。4实现架构及功能逻辑4.1功能逻辑描述建议分层描述本系统功能模块，功能模块可包含面向用户需求的功能模块，也可包含面向实现的功能模块（如实现数据库的通用访问等），层次建议两到三层。功能逻辑建议采用功能逻辑图＋文字说明方式描述，功能逻辑图建议采用Visio组织机构图来画，功能模块描述建议采用分级标题，便于组织和检索。样例：该例子分三个层次画出了三层功能模块，根据项目的实际情况，几层功能模块图可以画在一张上图上。4.1.1功能模块结构图样例4.1.1.1顶层功能模块图IdealFlow工作流系统组织定义工作流引擎流程定义管理及监控4.1.1.2二层功能模块图组织定义单位名称维护部门岗位定义部门定义个人设置…4.1.1.3三层功能模块图…4.1.2功能模块描述样例4.1.2.1组织定义具体描述…4.1.2.1.1单位名称维护具体描述…4.1.2.1.2部门定义具体描述…4.1.2.2流程定义具体描述…4.2软件体系架构该章节主要描述系统的实现的体系架构，以期使读者从总体上了解项目的设计框架。软件体系架构描述包括在物理上，对象之间通过函数或者过程调用相互作用；在逻辑上，对象之间通过集成、复合等方式实现设计的复用。该章节更多的内容面向编码和实现，对于不同的项目或采用不同的工具，设计文档使用的图示或工具可能不同，如面向对象的设计可以用高层次的类图、组件图、包图等和相关文字说明等描述整体的体系架构，面向过程的设计可能使用高层次的函数功能分解来描述，另外该章节内容也包括对源代码组成的高层次描述软件体系架构描述中，另外很重要的是描述系统采用通用或核心的模块、组件的设计思路及实现框架（如对数据库访问的通用实现）。这些通用设计在此处以及在后续设计文档的集中描述，有利用读者的理解和阅读，也有利于设计文档的维护。面向编码和实现，描述如何组织代码实现相关业务逻辑。对于不同的项目或采用不同的工具，设计文档使用的图示或工具可能不同，如面向对象的设计可以用高层次的类图、组件图、包图等和相关文字说明等描述整体的体系架构，面向过程的设计可能使用高层次的函数功能分解来描述，另外该章节内容也包括对源代码组成的高层次描述，建议的章节结构包括4.2.1设计思路描述系统总体设计采用的框架、工具、方法等，平台级的设计思路，以及对一些难点和复杂逻辑、权限等的处理思路对于通常的项目，设计思路可能包括多个部分，可以分子章节描述，如框架、权限、策略等等4.2.2包图及描述提示：直接通过数据库进行操作的统计报表类系统该部分可以不描述主要创建类包图，通过层次结构，以在逻辑上组织设计，在使用包图及描述中，要能体现设计和功能逻辑间的关系一些建议，把一个框架的所有类放置在相同的包中。一般把相同继承层次的类放在相同的包中。彼此间有聚合或组合关系的类通常放在相同的包中。彼此合作频繁的类，信息能够通过UML顺序图和UML合作图反映出来的类，通常放在相同的包中。对于通常的项目，包图可能有多个，可以分子章节描述样例，类包图示意，缺少描述4.2.3类图及描述提示：直接通过数据库进行操作的统计报表类系统，Sieble套件类系统该部分可以不描述主要创建类包图，通过层次结构，以在逻辑上组织设计，在使用类图及描述中，要能体现设计和功能逻辑间的关系。此章节类图描述系统实现的高层次主要类以及它们自己的关系（如继承、聚合等），并描述出这些类的主要作用，此章节对属性和方法不需要太细化。对于通常的项目，类图可能有多个，可以分子章节描述样例，类图示意，缺少描述4.2.4主要程序描述主要适合面向过程类设计或项目中复杂的逻辑处理，通过图释和说明描述项目中主要的函数功能以及调用关系，对函数的细节不需要太细化。对于通常的项目，主要程序可能有多个，可以分子章节描述4.2.5组件图及描述组件图，目的和“主要程序描述”相同，可以根据实际情况选择使用样例，组件图示意，非面向对象设计也可以有组件图，缺少描述4.2.6源代码目录结构以树型结构并结合描述描述出系统的较高层次的源代码目录结构，以便读者能很快理解项目程序结构的组织，目录层次的颗粒度应到覆盖到各需求功能模块、核心体系架构的实现（基本可以和上面的设计文档描述的层次相当。样例，仅供参考XXX项目源代码业务功能A登记模块，并初始化业务功能A1业务功能B打印组件打印模块，实现打印的通用功能图片库4.2.7权限设计说明该系统在权限设计的总体考虑。…4.3总体界面设计提示：后台接口类的项目该部分可以不写4.3.1设计原则该项目中界面设计的要求、限定等设计中要注意的原则4.3.2设计思路该界面实现的设计思路，如使用XML形成界面菜单，采用CSS提供多套样式风格等4.3.3界面风格界面的风格，如配色、操作等方面的考虑4.3.4界面层次图较高层次的界面的层次图，如建议和功能逻辑的层次相当4.3.5界面原型界面草图或美工设计的界面原型，可有主界面级、视图级、表单级等5详细设计详细设计是将“实现架构及功能逻辑”章节中功能逻辑、体系架构的内容在实现上的细化，以在更深的层次上分解功能逻辑和实现逻辑，整体的章节结构随着功能的细化可以看作对“实现架构及功能逻辑”的迭代和细化，但子模块的顶级章节层次仍采用二级标题层次。对于该章节采用的描述工具和方法，“实现架构及功能逻辑”使用的许多工具仍能适用，但该章节更面向具体的实现逻辑，根据不同的项目和使用的工具，可采用如流程图、顺序图、协作图等等来描述实现的细节。该章节的基本面向以编码为主的项目，对于许多集成类的项目，如Notes邮件配置、Tivoli单点登录实现，也建议按功能模块来划分，参考以下章节的内容，适当调整章节结构，根据情况增加一些相关的图示和描述，以表达清楚该功能的实现设计。如Notes的Internet邮件配置，需要描述邮件系统设计思路、拓扑框架及相关的配置文档；Tivoli的单点登录实现，需要描述每个相关系统采用哪种单点登录模式，应用系统和服务器相应的改变、相关的配置等等。对于章节的细分，根据需求分析设计的模式可以有不同的方式，如采用功能模块分解或主题域分解。对于目前的多数项目，虽然可能采用面向对象的语言实现，但我们多数采用面向过程的功能分解，一般建议子章节的结构采用功能逻辑分解。对于一些业务或实现上通用的功能及模块建议单独列出，集中描述。对于较大的