為什麼資料庫文檔會比應用程序代碼更重要

科技 08-18

技術資訊，第一時間送達！

作者丨Piotr Kononow

翻譯丨無阻我飛揚

摘要：本文從提出開發文檔的重要性開始，詳細闡述了資料庫文檔在資料庫應用中的重要性，以下是譯文

開發人員都知道開發和維護代碼注釋是多麼重要。這樣做不僅使代碼更容易瀏覽和理解，同事和自己在幾個月以後再回朔代碼的時候，也可以輕鬆測試和修改它。

舉一個例子，在應用程序資料庫中記錄數據結構（表和列）會更加重要，但它比代碼文檔更容易被忽視。以下是我認為的一些原因。

資料庫超出了項目的執行

從組織的角度來看，應用程序代碼只是在項目執行和團隊中考慮的。而另一方面，資料庫會被用於多個團隊活動和項目中，它的組織範圍更廣。

更多的訪問點

應用程序代碼主要會被開發人員和編譯人員「訪問」。然而，資料庫不僅會被應用程序訪問，而且會被更多的其他程序，報表，電子製表軟體，ETLs（數據抽取、轉換、裝載），即席查詢，商業智能系統等等訪問。

更多的用戶

你想想看，代碼和代碼文檔幾乎全由開發者使用。他們是需要了解它的人。對於大多數其它應用程序的相關人員，你的開發是一個黑盒。如果出了問題，用戶，測試人員，項目經理或者其他人，不是查看代碼找原因，而是電話開發、維護人員。

在數據案例中情況略有不同。有更多的人和應用程序需要在資料庫中直接訪問它。有支持顧問，業務分析師，數據分析師，其他團隊（數據倉庫/商業智能）的開發人員等等。

用戶更分散：組織上或地理上

一個開發團隊是一小群人坐在一個房間里每天喝著咖啡聊天，那自然是很好的。但是你想想看，所有人訪問數據時，他們可能甚至不知道他們自己的存在。這些人在各個IT、業務部門、供應商和顧問之間橫跨整個組織，這也是完全真實的，這些人可能在不同的洲。

在某個時刻

數據用戶在空間和時間上都是分散的。許多應用程序需要幾個月（有時是幾年）來實現，一旦部署好了代碼，功能就被限定死了。雖然有一些可擴展的特性（報表等等），但是核心代碼已經改不了了。團隊也是如此。但與資料庫不同的是，報告和分析的開發將很有可能會貫穿整個應用程序的生命周期，甚至更長時間。在應用程序已停止應用後，一些資料庫依然保持在線供報表和參考應用。