Article précédent

Article suivant

A propos

Travailleur indépendant depuis 6 ans, je vous propose mes services dans les domaines du développement, conseil et gestion de projets informatiques.

 

Télécharger CV

Documentation utilisateur

typefriendly.png

Cela faisait longtemps que je cherchais une solution de documentation orientée utilisateur. Pour la documentation technique, PHPDocumentor fait très bien le travail. J'avais aussi exploré la solution DocBook, intéressante mais assez fastidieuse à mettre en place. Parallèlement j'avais été impressionné par la qualité (graphique, mise à jour) de la documentation du framework symfony. Après quelques recherches, j'ai constaté que l'équipe de symfony utilisait le format "markdown" pour générer sa documentation utilisateur.

Le format markdown est un format plein texte avec balise très simple permettant de convertir des documents textes au format XHTML. Ce format avait été créé dans le but de favoriser la publication de contenu pour le web.

Initialement prévu pour être transformé en XHTML par du PERL, une solution pour PHP est disponible. Notamment pour le moteur de blog wordpress.

Finalement, j'ai trouvé une solution disponible proposé par Invenzzia sous licence GNU General Public License 3 : TypeFriendly

Bref, après une mise en place très simple et un apprentissage très rapide de la syntaxe, voilà une solution de génération automatique de documentation au format XHTML, avec table des matières, chapitrage, feuille de style personnalisable... bref un bel outil !