Discussion :

[elderion]

bonjour
Je cherche un systeme de documentation logicielle.

Si possible a la croisée d'une doc API (genre docbook) et d'une doc utilisateur final (wiki)
Le but est de :

1. pouvoir rédiger la doc technique d'une application au format XML :
- format typé, sémantique
- réutilisable
- exportable/importable

2. greffer une partie éditoriale
- une description détaillée,
- des exemples d'usage avec un widget de code highlighter
- des liens vers des règles de gestion.

Tout ca géré de facon simple (pour usage le quotidien), dans une interface web genre un Wiki ou un Wordpress.

N'hésitez pas a me dire si je suis pas clair ou completement à coté de la plaque, si je devrais separer les 2, ...

merci

[grunk]

http://www.phpdoc.org/ ?

[elderion]

phpdoc.org c'est pour faire de l'API technique pure.

L'idée ca serait de faire une doc utilisateur avec les méthodes exposée, exclus les rouages internes.
C'est finalement a la croisée entre un wiki (description détaillée, exemples, ...) et un WSDL (pour le format XML typé)

[Benjamin Delespierre]

Utilise Doxygen, PHPDoc c'est plus proche de PHP c'est vrai mais la documentation produite est vraiment misérable et le projet à l'air à l’abandon.

Voici la doc que j'ai réussi à obtenir avec Doxygen et un minimum de custo: http://bdelespierre.github.com/php-axiom/index.html

Tu peux y ajouter tes propres pages, tes propres tags, créer de nouvelles catégories, changer le layout, bref, tu fais ce que tu veux.

Doxygen

Donc:

1. pouvoir rédiger la doc technique d'une application au format XML :
- format typé, sémantique
- réutilisable
- exportable/importable

2. greffer une partie éditoriale
- une description détaillée,
- des exemples d'usage avec un widget de code highlighter
- des liens vers des règles de gestion.

Oui, Doxygen peut le faire.

Tout ca géré de facon simple (pour usage le quotidien), dans une interface web genre un Wiki ou un Wordpress.

Faut pas rêver ! L'informatique c'est pas magique
En revanche tu as une IHM pour paramétrer le générateur plus facilement.