Como documentar una base de datos Mysql???

[MARTIN_LAW]

Pues eso, mi pregunta es esa, tengo la base de datos creada y no se muy bien como documentarla, que debo documentar, que no debo.....

De momento tengo:

- Diagrama de tablas (donde aparecen las tablas de mi base de datos con sus campos, y las relaciones entre campos de las diferentes tablas)

- Esquema E-R


Tambien queria documentar de algun modo con una explicacion para que sirve cada una de las tablas de mi base de datos, y que almaceno en cada uno de los campos con una explicacion, me gustaria saber si existe alguna plantilla por ahi para ello.


muchas gracias

[huesos52]

Código MySQL:

mysql> CREATE TABLE ejemplo_documentacion(cod INTEGER) COMMENT 'tabla para ejemplo';
Query OK, 0 rows affected (0.05 sec)
 
mysql> DESC ejemplo_documentacion;
+-------+---------+------+-----+---------+-------+
| Field | Type    | Null | Key | Default | Extra |
+-------+---------+------+-----+---------+-------+
| cod   | int(11) | YES  |     | NULL    |       |
+-------+---------+------+-----+---------+-------+
1 row in set (0.03 sec)
 
mysql> SELECT table_name,table_comment FROM information_schema.tables WHERE table_name='ejemplo_documentacion';
+-----------------------+------------------------------------------+
| table_name            | table_comment                            |
+-----------------------+------------------------------------------+
| ejemplo_documentacion | tabla para ejemplo; InnoDB free: 4096 kB |
+-----------------------+------------------------------------------+
1 row in set (0.64 sec)
 
mysql>
 

Es posible que ciertas herramientas graficas den la posibildiad de hacer esto mas facil.
De igual forma puedes documentar cada columna.

saludos