Et si on arrêtait de se prendre la tête avec la documentation ?

Guillaume Scheibel
08 Sep 2015
17:30
LIST

Et si on arrêtait de se prendre la tête avec la documentation ?

DukeMDSeptember

“Est-ce que la doc est à jour ?”, “Elle est où la doc de la v1.5?”, “C’est quoi la différence avec la version précédente ?”, “C’est fatiguant de recréer à la main le PDF à chaque nouvelle version de l’application !”,“ C’est quoi le style pour les titres?”, “Arf Word m’a encore pété mes listes numérotés !”

Ecrire de la documentation, c’est la plupart du temps dans un fichier complètement distinct de l’application dont le format est contraignant pour le développeur, ce qui entraîne sa frustration et le résultat s’en ressent sur le livrable final. S’occuper de la forme n’est pas notre activité de prédilection, nous c’est le fond. Tout cela pour que ce document soit déposé dans un répertoire partagé voir au mieux dans une GED. Ne parlons même pas du fait d’essayer de voir la différence entre deux versions!

Si cette introduction vous est familière alors Asciidoctor est là pour vous. Simple, clair et concis. Durant cette présentation nous allons voir ensemble la syntaxe, l’intégration dans une applications et dans son cycle de vie ainsi que la personnalisation du rendu. Et vous vous rendrez compte que faire de la documentation n’est pas forcément une prise de tête.

Langue: FR