Wie kann ich eine Datenbank effektiv dokumentieren?

Question

Ich entwickle eine Datenbank, die wissenschaftliche Daten aus meiner Gruppe organisiert und verschiedene Experimente in der Literatur berichtet (mein Hintergrund ist eher in der Wissenschaft als in Projektmanagement oder Programmierung).

Ich habe derzeit drei Dokumentationsunterlagen für:

1. Endnutzern Daten
2. Daten eingeben-ers
3. Entwickler (zB ich und mein Nachfolger)

Anders als nach dem Benutzerhandbücher und Beschreibungen aus anderen Datenbanken, gibt es Best Practices, die ich befolgen sollte, vielleicht eine Latex-Vorlage oder eine mysqldump-Option, die automatisch einen Teil der Dokumentation übernimmt ?

Answer 1

Doxygen unterstützt SQL. Ich würde die DDL-SQL-Anweisungen exportieren, sie mit der Doxygen-Notation dokumentieren und sie in HTML/PDF/was auch immer exportieren.

Answer 2

Ich wünschte, es gäbe eine Standardlösung, aber die Branchenpraxis ist bestenfalls ad hoc.

In MySQL müssen Sie beim Erstellen von Tabellen und Feldern unbedingt die Kommentarfelder ausfüllen. Wenn Sie den MySQL-Administrator verwenden, erleichtert dies die Verwaltung. Dies ist jedoch für Entwickler besonders nützlich, da sie direkt verwendet werden können. Es kann als Basis für die Erweiterung für die anderen Kategorien von Lesern verwendet werden.