Autodoc permet de documenter de manière extrêmement simple et efficace une base de données.

Sous Debian, l'installation est simple. Commencez par mettre à jour vos sources apt :

$ apt-get update

Vérifiez la disponibilité du paquet :

$ apt-cache search postgresql-autodoc
postgresql-autodoc - Utility to create system tables overview in HTML, DOT and XML

Installez le paquet s'il est disponible :

$ apt-get install postgresql-autodoc

Pour les autres distributions, cherchez un peu... Ou alors, installez à partir des sources disponibles sur le site ;-)

Les formats de sortie sont multiples : graphiques avec Dia et GraphViz (dot) ou texte (HTML, DocBook)... voici quelques exemples en ligne sur le site d'Autodoc :

L'idéal est donc d'utiliser une combinaison de sorties textes et graphiques pour avoir une documentation complète de votre base de données. Personnellement, j'utilise DocBook et GraphViz...

Enjoy!