Как я могу эффективно документировать базу данных?

Question

Я разрабатываю базу данных, которая организует научные данные из моей группы и различные эксперименты, описанные в литературе (мой опыт в науке, а не в управлении проектами или программировании).

я в настоящее время есть три документации документы:

1. конечных пользователей данных
2. данных Энтер-ERS
3. разработчиков (например, я и мой преемник)

Другие, чем следуя руководства пользователей и описания из других баз данных, есть ли какие-либо лучшие практики, которым я должен следовать, возможно, латексный шаблон или параметр mysqldump, который автоматически выполнит часть документации ?

Answer 1

Doxygen поддерживает SQL. Я бы экспортировал SQL-запросы DDL, документировал их с помощью нотации Doxygen и экспортировал в HTML/PDF/что угодно.

Answer 2

Желательно, чтобы было стандартное решение, но отраслевая практика в лучшем случае является ad hoc.

В MySQL не забудьте заполнить поля комментариев при создании таблиц и полей. Если вы используете администратора MySQL, это упрощает управление, но это очень полезно для разработчиков. Его можно использовать в качестве основы для расширения для других категорий читателей.