文檔化數據庫項目以捕捉相關信息
2024-07-21 02:34:53
供稿：網友
在數據庫開發階段對其進行文檔化，可有效地捕捉組織架構、數據對象和其他相關信息，以便將來參考。
這個文檔的形式是多種多樣的，包括數據字典、數據庫治理員指南、數據庫體系結構信息以及數據庫功能規范。本文用“數據字典”這一術語來指代數據庫文檔。雖然你目前的數據庫文檔可能沒有使用這個名字，但基本原理是一樣的。本文有助于你更好地理解自己的數據庫文檔。
開發數據庫文檔
一個數據庫文檔的讀者包括：
數據庫結構師
數據庫開發者
數據庫治理員
生產支持人員
質量保證人員
開發數據字典的實際過程要由一個多功能團隊中的主力隊員來完成，包括數據庫治理員和/或數據庫結構師、業務分析員以及技術作家。雖然你的公司在分配數據庫文檔開發人員時有所不同，但數據庫文檔的核心必須來源于構建數據庫的那個團隊。
數據庫治理員可從數據庫本身提取必要的數據字典信息。在許多關系型數據庫治理系統（RDBMS）中，數據字典是作為一個電子文件提供的。DBA和數據庫開發者可從文件中提取有用的信息，包括：
列出數據庫中包括的所有文件。
數據庫中包括的每個文件中的記錄數。
每個數據庫字段的名稱和類型。
數據字典中包括的信息在普通用戶面前隱藏，防止內容遭受破壞。數據字典在數據庫中發揮的是治理職能，其中不包括任何實際的數據庫數據（雖然RDBMS要求一個數據字典來訪問來自數據庫的數據）。
業務分析員和技術作家由于具有印刷技術文檔方面的專長，所以在數據庫文檔化過程中也能發揮要害作用。雖然DBA提取的信息非常重要，但它仍需正確地表示，并向內部和外部的客戶群體傳達。除此之外，自動化文檔并不是萬能的，所以仍需業務分析員和技術作家提取被遺漏的技術信息。當然，業務分析員和技術作家不能是當前項目的門外漢，他們必須完全投入這個項目中，而不能臨時抱佛腳地最后突擊一下。
要包括到數據庫文檔中的典型元素
在你的數據庫文檔中，應考慮捕捉以下信息：
數據元素編號
數據元素名稱，這種名稱通常不能重復（名稱通常在設計階段決定，并要受到“需求收集”階段的一些影響）。
數據元素的簡短描述
數據元素的安全性分類（各單位通常對安全性分類有具體的要求。數據開發團隊和公司的安全團隊對此都有非凡的要求，所以應參加到安全性分類中來。對安全性分類的其他影響包括文檔要求、功能規范以及數據庫的設計文檔）。
與特定數據元素具有重要關系的相關數據元素的列表。
基于數據庫架構和/或RDBMS所提供的技術名稱的字段名。
代碼格式，包括任何必要的非凡表示法，以及數據類型的格式和大小。
默認的數據值（要在此列出所有存在默認值的變量）。
元素編碼，對編碼和驗證規則進行了解釋
對其他文檔的引用，列出該元素和數據庫文檔及數據字典中文檔化的其他元素之間的任何驗證規則
數據庫表引用
元素的數據源
數據元素的有效日期
歷史引用
擴展引用
數據元素版本
上述提綱羅列了通常要包括進來的文檔小節，你可根據自己的實際需要進行修改。
還要為數據庫的表撰寫文檔。使用SQL命令help table，就可為一個SQL數據庫提取這些表信息，包括：
表名
數據庫或表所有者姓名
數據元素列名和具體資料
所有元素的鍵序
數據庫索引信息
技術性表組織
重復行信息（是否答應重復行）
數據元素列表
表安全性分類
計劃數據庫文檔時，還要考慮到數據庫架構。可利用Visio等工具開發數據庫架構的一個圖形化表示，以便將其包括到印刷文檔中。
自動化數據庫文檔化工具
有多種自動化的文檔化工具可供選擇，例如：
由A&G Software開發的AGS SQL Scribe Documentation Builder Version 3.0 可自動生成Microsoft SQL Server數據庫文檔。
由.com Solutions公司開發的 InstallGen 可自動生成Oracle數據庫文檔。
Microsoft Visio PRofessional 2002也是一款非常流行的數據庫文檔工具。它包括以下模板：
數據庫模型圖
EXPress-G
ORM圖
最佳做法
數據庫文檔的“最佳做法”是綜合運用自動化工具以及有經驗的業務分析員和/或高級技術作家的幫助。有這些人提供幫助，再配合數據庫結構師、開發者和治理員的專業技能，就能保證文檔符合所有人的需要和希望。
