详细设计文档 转

在大多数软件项目中，要末不作详细设计，要么开发完成后再补详细设计文档 ，质量也不容乐观，文档与系统往往不能同步，使详细设计文档 完 全流于形式，对工作没有起到实际的帮助。

那到底应不应该写详细设计文档 呢，怎么使详细设计文档 起到他应有的作用呢，下面就让我们来认识一下详细 设计及写详细设计文 档 的好处和问题。

·             什么是详细设计

详细设计是相对概要设计而言的，是瀑布开发流程的一个重要环节，在概要设计的高层设计的基础上，从逻辑上实现了 每一模块的功能，是编码阶段的主要参考资料，是从高层到低层、逐步精化思想的具体实现。

详细设计文档 的 内容 包括各个模块的算法设计， 接口设计， 数据结构设计，交互设计等 。必须写清楚各个模块 / 接口 / 公共对象的定义，列明各个模块程序的 各种执行条件与期望的运行效果，还要正确处理各种可能的异 常。

·             为什么要作详细设计

在开发过程中，由需求及设计不正确、不完整所导致的问题是项目进度拖延、失败的一个主要因素，而软件系统的一个 重要特性就是需求和设计的不断构建和改进，在写详细设计文档 过程中， 详细设计实际上是对系统的一次逻辑构建，可以有效验证需求的完整性及正确性。

如果不写详细设计文档 ，一般就从概设直接进入编码阶段，这时开发人员所能参考的资料就是需求规格说明书及页面 原型、数据库设计等，不能直接进行开发，需要进行信息的沟通，把页面原型不能体现的设计讲清楚，这样既容易遗忘，也容易发生问题，详细设计文档 可以 作为需求人员、总体设计人员与开发人员的沟通工具，把静态页面无法体现的设计体现出来， 包含 整体设计对模 块设计的规范，体现对设计上的一些决策，例如选用的算法，对一些关键问题的设计考虑等等，使开发人员能快速进入开发，提高沟通效率，减少沟通问题。

      对于系统功能 的调整，后期的维护，详设文档提供了模块设计上的考虑、决策，包括模块与整体设计的关系、模块所引用的数据库设计、重要操作的处理流程、重要的业务规则实 现设计等等信息，提供了对模块设计的概述性信息，阐明了模块设计上的决策，配合代码注释，可以相对轻松读懂原有设计。

·             存在的问题

要由专门的人写，是比较麻烦的，也是很需要时间的，会对进度造成压力，也容易形成工作瓶颈，使设计人员负担过 重，而开发人员无事可作。对于现在一般的以数据库为中心的管理系统而言，这个工作始终是要作的，区别只不过是不是形成专门文档，形成文档可能会多花一两周 时间，但相对于规避的风险和问题来说，也是值得的，另外由于现在高级语言的流行，所以更详细的设计应该直接体现在代码的设计上，而文档则只体现设计上的一 些决策，协调整体设计与模块设计的关系，把页面原型所不能体现的设计情况文档化，所以所花费的时间是有限的。

设计内容 容易过细，但设计阶段是不能考虑特别清楚地，时间也不允许。
对于这个问题，一个对策是上边所 提到的，文档只体现设计上的决策，页面原型所不能反映的信息，详细设计只体现总体设计对模块设计的一些考虑，例如对功能的数据库设计等等，而具体的实现实 现，则到代码中再去实现，相关的设计也仅体现在代码中。
    需求、设计需要不断的被更新、构建，则设计文档需要不断的重新调整，文档的维护需要跟上，否则文档和系统的同步 就很难得到保障了，且造成多余的工作量。文档的内容 易流于形势，质量糟糕，不能成为开发人员的参考手册，一是要建立起相关制度，如有修改，先改文档，后作开发，从工 作流程上切实保障文档与系统的同步，二是要规范文档质量，对文档该写什么，不该写什么，标准是什么，粒度是什么，语法应该如何组织，有明确的标准和考虑， 同时，建立审计文档评审、审核制度，充分保障系统的使用。

 

·             应该如何写详细设计文档

下面讨论如何写出一个符合要求、实用的详细设计文档 。

首先是文档的内容 ，根据项目和团队的不同，详细设计文档 的内容 也有所不同，一般说来，粒度不宜过细，不能 代替开发人员的设计和思考，但要把有关设计的决策考虑进去，包括与其他模块、整体设计的关系、操作的处理流程，对业务规则的设计考虑等，有一个标准为，凡 是页面原型、需求规格说明书所不能反映的设计决策，而开发人员又需要了解的，都要写入文档。

       其次是文档所面向的读者，主要为模块开发人员、后期维护人员，模块开发人员通过详细设计文档 和页 面原型来了解所开发的功能，后期维护人员通过实际系统、模块代码、详细设计文档 来了解一个功能。

   再有就是谁来写文档，因为文档主要考虑的是设计上的决策，所以写文档的人应该为负责、参加设计的技术经理、资深程序员，根据团队情况和项目 规模、复杂度的不同，也有所不同。

   还需要保证文档的可读性、准确性、一致性，要建立严格的文档模板及标准，保证文档的可读性及准确性，同时建立审核及设计评审制度，来保障设 计及文档的质量，另外在工作流程中要强调，要先设计、先写文档，再进行开发。