Bonjour à tous!
Je suis actuellement en stage (j'ai commencer lundi) et mon travail pour le moment est de réaliser une documentation d'un logiciel en php que je devrais ensuite modifier.
Mais je ne sais pas du tout comment mis prendre pour faire cette documentation et je n'ai pour le moment personne pour m'encadrer (partie en vacances).
Pourriez vous m'aider.
Merci

Salut.

Deja, il serait bon de nous dire sous quel environnement tu veux travailler. Moi je suis sous Linux et je pense a la doc sous Windows. Je vais donc essayer au mieux de faire un fichier de doc qui pourra etre lu sous les deux systemes. Je penses aussi a MacOs. Pour cela je penche plus sur un format PDF qui est lu par tout le monde.
Tu peux aussi faire ta documentation en page web qui elle aussi est lu par tout les navigateurs.
Pour la documentation technique, on a mis en place PHPDocumentator qui te lis les fichiers source PHP et qui t'en fait une doc html. Il faut bien sur avoir mis assez de commentaire dans le code pour permettre cette solution.

En esperant avoir ete assez clair.

EDIT: J'ai oublie de parler de latex qui permet de faire un fichier source (style html avec des balises) qui sera modifier soit en PDF, soit en html. Je crois qu'il est possible de faire encore bien d'autres formats.

Merci beaucoup pour ces renseignement qui me seront je pense très utile.

Mais en fait je voulais parler du contenu de la documentation et de sa structuration (c'est la 1ere fois que j'en fait une ).

Merci!

Desole, je n'avais pas compris le sens de la question.

Je penses que tu devrais commencer par deux parties :
La premiere qui explique globalement ce que fait l'application. Ceci te permettra de mieux comprendre l'application.
La deuxieme serait plus detaillee et expliquerait les parties techniques employees et le fonctionnement precis que l'on doit obtenir.

Tu peux aussi rajouter une petite doc sur les conventions de codage, les technologies employees et les systemes supportes (BDD, PHP, os, etc...).

Merci beaucoup!

Je vais me basée sur ça pour faire la documentation.
Si vous avez d'autres indications n'hésitez pas à me les communiquer.

si tu veux, je peux t'envoyer des exemples de docs techniques par mail... (MP)

Oui je veut bien merci :
c'est [email protected]

C'est une documentation fonctionnelle ou technique ?
Ca se rapproche d'un manuel d'utilisateur ou de la documentation du code source de l'appli ?

Les deux je pense!

Les deux je pense!

Uhm c'est pas je pense la bonne réponse !!
Clairement en entreprise les deux sont séparés car destinés à des acteurs totalement différents.
Il faut que tu saches quel type de doc tu dois réaliser.
Moi je ne peux te fournir qu'un exemple de doc technique. Logique non ?;)

Si tu dois réaliser les deux, ça se fera en deux temps avec des outils radicalement différents, etc, etc.

Pour la doc technique, le plus utilisé en php est phpDocumentor, qui te génère ta doc à partir des commentaires (lorsqu'ils sont au bon format) dans ton code (devant une fonction, devant un paramètre, au début d'un fichier, etc).