数据库设计文档化---详细文档

因为不够详细的设计文档很可能让设计人员的电话打爆，让开发人员瞎蒙某些字段的含义。

数据库设计文档怎样才算写的详尽呢？

下面我们以物理设计文档为例，讨论如何书写详尽的数据库文档。

1、基本的设计需要。如表的定义，表中各个字段的定义等等。这也是我们最常见的数据库物理设计文档。(咱刚开始做数据库物理设计就提供这样的文档，哈哈)

2、扩展设计的需要。某些字段的缺省值、Check约束、外键约束等，表的索引、触发器、物理存储等。

3、将数据库中的SQL函数、存储过程等等所有数据库对象都添加到数据库物理设计文档中。

4、数据库访问权限。很多设计师都会遗漏这一块内容。对于简单的系统由DBA去创建数据库的时候分配权限即可，而复杂的系统(很多个数据库用户)最好还是将数据库的权限写进文档，统一设计维护。

注：以上几点确保仅靠一份数据库物理设计文档就能产生一个物理数据库，而不需要做其它物理数据库的DDL或DML操作。

5、每个数据库对象的用途注释、取值注释(如性别字段的取值注释)等等。这个步骤很多设计师都不愿意或者干脆省略掉。其实时间一久，人的记忆力是不可靠的。更重要的是设计师离职等因素将导致整个系统的可维护性急剧降低，后续设计师可能一换再换，开发人员一跑再跑。

6、由数据库内容来维护设计文档。很多公司，很多时候，国内数据库设计师的地位并没有想象中的那么高(除了兼做数据库设计的项目经理/主管)，开发人员很可能会自己添加某些表的索引，增加存储过程、增加函数等，他们最多就是通知一声设计师说我加了个某某东西。这时候设计师如果不跟进，将新加的东西增加到设计文档中，日子一久，原来的数据库物理设计文档将变得毫无意义，而且可能会让人误入歧途。因此没有进行维护工作的设计文档很可能就是一份形式主义报告。

来自 “ ITPUB博客 ” ，链接：http://blog.itpub.net/16573/viewspace-434625/，如需转载，请注明出处，否则将追究法律责任。

转载于:http://blog.itpub.net/16573/viewspace-434625/