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

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

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

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

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/

数据库设计文档化---详细文档相关推荐

数据库设计步骤（超级详细）|数据库
数据库设计我们先来看这样一个问题假如遇到下面这样的设计需求,我们如何完成数据库的设计呢? 设计需求: 假设商品经销商有基本实体集:供应商Vendors.产品目录Products.顾客信息Custo ...
架构师之路 — 数据库设计 — SQL 结构化查询语言
目录文章目录目录 SQL 结构化查询语言 SELECT 查询语句 WHERE 过滤语句 ORDER BY 排序语句 GROUP BY 分组语句集合运算语句 UNION 并集运算 INTERSEC ...
文档化Python代码完全指南（翻译）
阅读代码比编写代码更多,有良好丰富文档的项目会吸引更多人使用和参与开发贡献.本教程旨在详细阐述如何将 Python 代码实现"文档化",介绍了注释用法.类型提示.文档字符串.在项目 ...
第6章 SQL Server数据库设计
6.1. 概述数据库设计是指对于给定的一个应用环境,构造最优的数据库模式,使之能够有效地存储数据,满足各种用户的应用需求(信息要求和处理要求). 可以将数据库设计理解成三个要素:应用环境.数据库模式 ...
校运动会mysql索引_（定稿）校运动会数据库设计（完整版）
<校运动会数据库设计.doc>由会员分享,可免费在线阅读全文,更多与<(定稿)校运动会数据库设计(完整版)>相关文档资源请在帮帮文库(www.woc88.com)数亿文档库存里 ...
如何设计新零售行业数据库？不懂SKU、SPU？带你走进数据库设计，用最容易理解的方式讲述数据库设计思想
数据库设计思想-使用新零售行业数据库带你走进数据库设计本篇文章会详细描述数据库设计中问题的解决思路,为什么不用其他方案都会说明. 可能有的小伙伴只是想找数据库做参考,帮忙帮到底,点击下载概述像酒 ...
2021蓝旭工作室暑期第五次培训课-数据库设计文档
数据库设计文档 1. 需求分析设计目标是设计一款用于餐饮外卖的系统. 如今,外卖市场已经成为O2O模式下的热点.本项目设计了一个外卖点餐系统,为餐厅提供资源配置的解决方案,满足O2O理念的要求. ...
Mysql导出数据库设计文档
现阶段因为项目验收需要提供数据库设计文档,在网络搜所后发现总有各种各样的问题导致导出效果不理想,所以基于lowagie包下的功能实现导出需求. Maven添加依赖 <dependency> ...
CYQ.DBImport 数据库反向工程及批量导数据库工具 V2.0 发布[增加批量导出数据库脚本及数据库设计文档]...
上次发布的:CYQ.DBImport V1.0的相关介绍:CYQ.DBImport 数据库反向工程及批量导数据库工具 V1.0 本次发布的V2.0 版本,准备突击海外,下面为相关的介绍. 一:新版本2 ...

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

数据库设计文档化---详细文档相关推荐

最新文章

热门文章