设计文档简介及检查重点

设计文档是软件开发项目中十分重要的一类文档，它是用来在软件设计开发团队内部以及与各干系人之间进行沟通的文档，这些文档描述了软件项目的整体架构，阐述了开发过程中的各种算法，记录了设计的方案与思路、以及各种决策意见。设计文档既能向用户展现软件的功能与性能，同时也是工程监理实施监理工作的重要依据。

一般情况下，设计文档包含：概要设计说明书，详细设计说明书，数据库设计说明书（如果有）等。在编写设计文档前，应仔细阅读需求调研报告、需求规格说明书，并与需求调研人员进行详细交流，在充分理解软件需求的基础上，提出多个设计方案，分析每种方案各自的优缺点，进行相互比较，最终得出最优秀的软件结构、模块划分、功能分配以及流程处理。在此以后，方可编写对应的设计说明书。

概要设计说明书又称为系统设计说明书，目的是将软件系统需求转换为未来系统的设计；使设计适合于实施环境；将结构分解为模块和库。具体来说，概要设计的主要任务包括以下几方面：指出任务的目标、需求；制定规范（接口规范、命名规范、代码体系等）；列出总体结构设计（整体架构图、模块间的关系）；与此对应的是各个模块设计（说明每个模块的功能以及实现方法）；性能设计；安全设计；数据库设计；接口设计。在书写概要设计需要把握由粗到细的原则，互相结合的原则，同时要系统考虑系统的一般性、关联性、整体性和层次性。

详细设计说明书又称为程序设计说明书，是在概要设计说明书的基础上进一步明确系统结构，详细的介绍系统的各个模块。例如，数据库设计，在详细设计说明书中需要编写出一个完成的数据字典，包括类型、字段说明、表说明等；又如概要设计中的模块设计，在详细设计中要逐个划分，实现每个模块的算法设计，界面设计等，并对各功能模块进行详细的图文描述；同时要写出此功能需要计算机的硬件资源，以及需要占用资源情况。

在软件开发商完成设计文档的编制后，需要提交甲方（监理方）进行审核。甲方（监理方）审核的重点分为两个方面：

第一，确认设计的功能，性能，安全设计等达到了用户的要求。在编写设计说明书前，承建方已经提交实施方案以及其对应的需求文档，甲方（监理方）重点的审核方面是上述两类文档中提到的各方面的设计是否都包含在设计文档中，功能、性能、安全等是否满足上述文档中的要求。

第二，文档完整性。毋庸置疑，对于整体设计来说，是否满足了用户的需求是最重要的，同时设计文档的完整性一样重要。一份完整的设计说明书，除了包括上述所说的内容以外，还应包括：系统概述、整体的设计思想（部署图），每个模块（功能）的处理流程图，系统维护设计，出错设计等，只有这些方面都写到了，才能算是一份完整的设计文档。

综上所述，一份合格的设计文档应具有清晰性、完整性、一致性、可行性等特性。除此之外，文档中语言表述清晰，文档结构鲜明，适时的图文结合，都是一份高质量设计文档必不可少的条件。

作者：张一驰