Discussion :

[JMLLB]

Bonjour,

Je cherche un moyen de simplifier le travail de documentation des softs sur lesquels je travaillent et notamment sur les aspects database.
Dans 9 cas sur dix lorsque j'ai la chance de tomber sur une spe décrivant une base de données,elle plus ou moins obsolète.
Résultat: je pars de la base elle même dans la plupart des cas.

Mon idée est d'intégrer une description courte des tables et des colonnes de la base pour limiter les risques de divergence, un peu comme les commentaires dans le code qui peuvent remplacer des specs bas niveau.

Est-ce que quelqu'un connait un moyen pas trop intrusif de faire ça, ou une convention voir un outil de génération automatique de docs (on peut rêver).

cordialement,

/JLB

[islamov2000]

bonjour
peux tu illustrer(donner un exemple) pour mieux comprendre

[JMLLB]

Généralement dans une spec de données on trouve un descriptif du typage de tes donnes (ce que tu obtiendrai en faisant un "show columns") et une description courte d'une vingtaine de mots qui résume l'utilisation de la colonne.
L'idée est d'embarquer cette courte description dans la base de données pour éviter une dérive entre la doc et le "code".

Pour l'instant la seule option que je vois, c'est de le faire dans les scripts de création de table en tant que commentaire et passant par une génération de doc via un outil style doxygen.

[deltree]

salut à tous.
J'ai compris que tu voulais un genre de reverse ingeneering sur la db.
Je ne pense pas qu'il y ai un moyen standard en odbc, ça va dépendre de Bases de données: en Orale, c'est "desc TABLE", en db2 ce sera dans les tables systèmes "sysibm.syscolumns"

Peut-être qu'en répertoriant les tables systèmes de chaque db ce serais possible...

PS: avec une sortie XML, et un rendu HTML via un XSLT ça sera un bon truc, j'ai déjà vu ce genre de chose maintenu à la main avant.

[JMLLB]

merci pour vos réponses, je vais me débrouiller avec ça je pense.

[JMLLB]

Un lien intéressant:

http://drupal.org/node/28046