Forum d'entraide PHPFrance

Bonjour ,
Au cours d'un stage , j'ai developper un "logiciel" en php mysql et css.
Et aujourd'huit je suis censé en faire la documentation, mais le probleme est que je ne sait pas quoi y mettre et que je trouve pas de docs a ce sujet.

Si vous savez a quoi correspond une documentation de logiciel je serais bien intéréssé.

Merci d'avance

une fois que tu sais ce qu'est ce que la documentation d'un logiciel, ceci te sera peut être utile :
Comparatif des générateurs de documentation PHP :
http://cyberzoide.developpez.com/php4/phpdoc/

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

salut,

ça dépend de ce que tu entend par documentation et à qui elle est destinée.

Par exemple pour un administrateur, tu n'aura qu' présenter les grandes parties.

Par contre pour un utilisateur (souvent les pires de tous), il faut expliquer la fonction de chaque bouton.