如何有效記錄數據庫？

Question

我正在開發一個數據庫，用於組織我的小組的科學數據和文獻中報告的各種實驗（我的背景是科學而不是項目管理或編程）。

我目前有三個文檔文件：

1. 數據的最終用戶
2. 數據輸入-ERS比繼
3. 開發者（如我自己和我的繼任者）

其他用戶指南和來自其他數據庫的描述，有沒有我應該遵循的最佳實踐，可能是乳膠模板或mysqldump選項，它們會自動完成一些文檔？

Answer 1

Doxygen支持SQL。我會導出DDL SQL語句，用Doxygen表示法記錄它們並將其導出爲HTML/PDF /無論如何。

Answer 2

我希望有一個標準的解決方案，但行業慣例是特設的充其量。

在MySQL中，創建表和字段時務必填寫註釋字段。如果您使用MySQL管理員，則易於管理，但這對於開發人員直接使用非常有用。它可以作爲其他類別讀者擴展的基礎。