代码的艺术:用工程思维驱动软件开发
上QQ阅读APP看本书,新人免费读10天
设备和账号都新为新人

2.6.2 设计文档的分类

系统设计文档可以分为以下几类。

(1)总体设计文档:描述系统的总体构成和运行机制。

(2)子系统设计文档:描述构成系统的某个子系统的组成和运行机制。

(3)接口定义文档:描述系统对外提供的接口。

(4)关键算法说明文档:描述系统中的关键算法。

(5)数据表设计文档:描述系统使用的数据表的设计,可能是数据库的设计,也可能是其他存储设备的设计。

……

以上这些设计文档应该是相互独立的,都有各自的主题和聚焦点。有一种错误的做法是,把这些内容都混杂在一个文档中,这是我非常反对的做法。

将不同类型的设计文档独立存放的原因基于以下几点。

(1)便于读者阅读。每个文档都有特定的读者,比较典型的是“接口定义文档”,这个文档是提供给系统的外部使用者的。外部使用者并不需要了解系统的内部设计。

(2)便于编写文档的人进行修改和维护。进行切分文档后,在做修改维护时冲突的可能性会大大降低,同时也降低了设计文档成为“巨型文档”的可能性,对短小的文档进行阅读和维护的难度都更低。