2010-12-01 95 views
3

我正在开发一个数据库,用于组织我的小组的科学数据和文献中报告的各种实验(我的背景是科学而不是项目管理或编程)。如何有效记录数据库?

我目前有三个文档文件:

  1. 数据的最终用户
  2. 数据输入-ERS比继
  3. 开发者(如我自己和我的继任者)

其他用户指南和来自其他数据库的描述,有没有我应该遵循的最佳实践,可能是乳胶模板或mysqldump选项,它们会自动完成一些文档?

回答

4

Doxygen支持SQL。我会导出DDL SQL语句,用Doxygen表示法记录它们并将其导出为HTML/PDF /无论如何。

+0

+1 - 我不知道Doxygen可以做到这一点。谢谢。 – Martin 2010-12-02 07:20:36

2

我希望有一个标准的解决方案,但行业惯例是特设的充其量。

在MySQL中,创建表和字段时务必填写注释字段。如果您使用MySQL管理员,则易于管理,但这对于开发人员直接使用非常有用。它可以作为其他类别读者扩展的基础。