Logo Questions Linux Laravel Mysql Ubuntu Git Menu
 

How can I effectively document a database? [closed]

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?

like image 911
David LeBauer Avatar asked Dec 13 '25 22:12

David LeBauer


1 Answers

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

like image 136
Reinderien Avatar answered Dec 16 '25 11:12

Reinderien



Donate For Us

If you love us? You can donate to us via Paypal or buy me a coffee so we can maintain and grow! Thank you!