如何有效地记录数据库？

I am developing a database that organizes scientific data from my group and diverse experiments reported in the literature, (my background is in science rather than project management or programming).

我正在开发一个数据库来组织我的小组的科学数据和文献中报道的各种实验(我的背景是科学而不是项目管理或编程)。

I currently have three documentation documents for:

我目前有三个文档文档:

1. end users of data

最终用户的数据

2. data enter-ers
3. developers (e.g. myself and my successor)

开发人员(例如我和我的继任者)

Other than following the users guides and descriptions from other databases, are there any best-practices I should follow, perhaps a latex template, or a mysqldump option that will automatically do some of the documentation?

除了遵循其他数据库的用户指南和描述之外,是否有任何我应该遵循的最佳实践,可能是乳胶模板,还是会自动执行某些文档的mysqldump选项?

2 个解决方案

#1

Doxygen supports SQL. I would export the DDL SQL statements, document them with Doxygen notation and export it to HTML / PDF / whatever.

Doxygen支持SQL。我将导出DDL SQL语句,使用Doxygen表示法记录它们并将其导出为HTML / PDF /等等。

#2

I wish there were a standard solution, but industry practice is ad hoc at best.

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

In MySQL, be sure to fill in the comment fields when creating tables and fields. If you use MySQL administrator, it makes it easy to manage, but that's most useful for developers to directly use. It can be used as the basis for expansion for the other categories of readers.

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