データベースを効果的に文書化するにはどうすればよいですか？

Question

私は、私のグループの科学的データと文献に報告されている多様な実験を整理するデータベースを開発しています（私の背景は、プロジェクトマネジメントやプログラミングではなく科学にあります）。

私は現在のための3つのドキュメントのドキュメントがあります。データの

1. エンドユーザー以下より
2. 開発者（例えば私と私の後継者）

その他

データ入力-ERSをユーザーのガイドと他のデータベースからの説明には、私が従うべきベストプラクティス、おそらくラテックステンプレート、またはいくつかのドキュメントを自動的に行うmysqldumpオプションがあります？

Answer 1

DoxygenはSQLをサポートしています。 DDL SQL文をエクスポートし、Doxygen表記で文書化し、HTML/PDF /その他にエクスポートします。

Answer 2

標準的な解決方法がありましたら幸いですが、業界の慣行は最高です。

MySQLでは、テーブルとフィールドを作成するときに必ずコメントフィールドに記入してください。 MySQL管理者を使用すると、管理が容易になりますが、これは開発者が直接使用するのに最も便利です。これは、他のカテゴリの読者のための拡張の基礎として使用することができます。