par
zeus » 30 janv. 2007, 15:59
La documentation d'un logiciel ne se limite pas à documenter le code.
Pour moi, la base d'un logiciel bien documenté, c'est un manuel utilisateur permettant la prise en main du logiciel par tous.
Ensuite, il y a un document d'installation/configuration/déploiement
Enfin, il y a la documentation du code.
Mais, toujours selon moi, quand tu as bien commenté ton code et si tu as eu la bonne idée de suivre la syntaxe PHPDoc, cette dernière étape n'est pas la plus longue ni la plus compliquée

La documentation d'un logiciel ne se limite pas à documenter le code.
Pour moi, la base d'un logiciel bien documenté, c'est un manuel utilisateur permettant la prise en main du logiciel par tous.
Ensuite, il y a un document d'installation/configuration/déploiement
Enfin, il y a la documentation du code.
Mais, toujours selon moi, quand tu as bien commenté ton code et si tu as eu la bonne idée de suivre la syntaxe PHPDoc, cette dernière étape n'est pas la plus longue ni la plus compliquée ;)