文档化数据库项目以捕捉相关信息

在数据库开发阶段对其进行文档化，可有效地捕捉组织架构、数据对象和其他相关信息，以便将来参考。

这个文档的形式是多种多样的，包括数据字典、数据库管理员指南、数据库体系结构信息以及数据库功能规范。本文用“数据字典”这一术语来指代数据库文档。虽然你目前的数据库文档可能没有使用这个名字，但基本原理是一样的。本文有助于你更好地理解自己的数据库文档。

开发数据库文档

一个数据库文档的读者包括：

• 数据库结构师
• 数据库开发者
• 数据库管理员
• 生产支持人员
• 质量保证人员

开发数据字典的实际过程要由一个多功能团队中的主力队员来完成，包括数据库管理员和/或数据库结构师、业务分析员以及技术作家。虽然你的公司在分配数据库文档开发人员时有所不同，但数据库文档的核心必须来源于构建数据库的那个团队。

数据库管理员可从数据库本身提取必要的数据字典信息。在许多关系型数据库管理系统（RDBMS）中，数据字典是作为一个电子文件提供的。DBA和数据库开发者可从文件中提取有用的信息，包括：

• 列出数据库中包括的所有文件。
• 数据库中包括的每个文件中的记录数。
• 每个数据库字段的名称和类型。

数据字典中包括的信息在普通用户面前隐藏，防止内容遭受破坏。数据字典在数据库中发挥的是管理职能，其中不包括任何实际的数据库数据（虽然RDBMS要求一个数据字典来访问来自数据库的数据）。

业务分析员和技术作家由于具有印刷技术文档方面的专长，所以在数据库文档化过程中也能发挥关键作用。虽然DBA提取的信息非常重要，但它仍需正确地表示，并向内部和外部的客户群体传达。除此之外，自动化文档并不是万能的，所以仍需业务分析员和技术作家提取被遗漏的技术信息。当然，业务分析员和技术作家不能是当前项目的门外汉，他们必须完全投入这个项目中，而不能临时抱佛脚地最后突击一下。