文件化數據的目標是幫助使用者找到、理解並自信地使用數據。
但你不需要文件化所有內容。良好建模的數據通常是不言自明的。
「好的程式碼會自我文件化」這句話有相當的道理。你的目標應該是使用具表達力且一致的名稱，使其具有自我描述性。一個名為「dbo」的資料庫沒有幫助，「sales_prod」會更好，特別是當還有「sales_dev」和「finance_prod」資料庫時。
因此，文件化始於命名事物，但並不止於此。
使用資料庫系統的明確層級結構來建立由上而下的文件
這樣使用者將開始理解全貌，並能夠自行瀏覽您的數據環境。
文件化數據時應關注什麼
完整文件化前 3 個層級（系統、資料庫、結構描述）。專注於文件化最常用的前 10% 表格。建立一個流程，所有新表格/視圖/模型都應建立至少最基本的文件（在建立過程中，文件化最容易）。
通常只有對於數據產品或廣泛使用的報表表格，文件化所有欄位才值得。但對於這些，您應該嚴謹。如果一個欄位不值得文件化，它就不應該成為表格的一部分。
在實務上，選擇正確的詞語可能很困難。我應該使用客戶還是帳戶還是公司還是使用者還是網站？團隊中的每個人都理解我們使用的縮寫嗎？
為了應對這些挑戰，理想情況下，您的文件系統應支援您使用詞彙表，您可以在其中定義重要的術語一次，並在文件中參考它們。
提示
- 使用具表達力且一致的名稱；
- 由上而下文件化和文件化最常用的項目；
- 通常一句話就足夠了；
- 將文件化納入開發流程的一部分；
- 在商業詞彙表中使用#定義；