Discussion :

[EvilAngel]

Salut à tous,

j'ai réalisé un projet web pour une boite d'info.
Aujourd'hui je dois quitter cette boite et personne ne fait de prog PHP/MySQL.

Ils souhaitent donc tout naturellement que je documente mon projet au mieux afin de faciliter la transmission du projet vers un uatre programmeur.

Les technos sont assez simples: PHP5/MySQL5/XHTML/CSS.

J'imagine laisser l'anaylse MERISE de la base de données (le plan en gros) mai ensuite je ne sais pas trop quoi fournir comme doc.

J'ai commenté mon code source abondemment.

Je pense ausi réliser une petit manuel avec des screeenshots pour expliquer ce que fait chaque page.

Quelle genre de doc aimez-vous trouvez si vous avez deja repris une projet web ?

Merci

[KiLVaiDeN]

Salut,

Ce que j'aime retrouver comme doc, c'est par exemple la description des classes ( diagramme de classe eventuellement ) si tu utilises la programmation objet; ça permet d'avoir une vision rapide des dépendances

Sinon, quelques algorithmes compliqués expliqués vite fait, c'est aussi important, ça permet rapidement de le debugger si il faut.

Dernière chose que je vois, le code source formatté pour être "extrait", par exemple avec Doxygen. Ca permet d'avoir d'un coté une doc lisible sans examiner le code source, ce qui peut parfois être fastidieux et long

A+

[EvilAngel]

Salut,

bien que j'utilises du PHP5, j'ai réalisé le site en programmation strucuturée, donc sans classes.

Je pensais également faire un diagramme de navigation, telle page va sur telle page, qui va sur telle page...

Bonne idée ?

[KiLVaiDeN]

Oui c'est une bonne idée, eventuellement quelques diagrammes de use case associés à des diagrammes de séquence, ça facilite énormément la compréhension des processus

A+