Why documentation should be a pain in my ass ?

Salle BS30, 14:45 - 15:30

• Incubateur

“Est-ce que la doc est à jour ?”, “Qu’est ce qu’il y a dans la version précédente ?”, “C’est fatiguant de recréer à la main le PDF à chaque nouvelle version de l’application !”, “Comment je génère la table des matières dans cette m**!”, “ C’est quoi le style pour les titres?”, “Arf Word m’a encore pété mes listes numérotés !”

Lorsqu’on écrit de la documentation, c’est la plupart du temps dans un fichier complètement distinct de l’application. On passe une bonne partie du temps à faire de la forme plutôt que du fond. Et bien sûr pour que ce document soit déposé dans un répertoire partagé voir au mieux dans une GED. Évidemment voir la différence entre 2 versions est juste un plaisir.

Si cette petite introduction vous est familière alors Asciidoctor est là pour vous. 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 ne sera plus une “pain in your ass!”

• Level: Shu (débutant)

• Topic: Documentation, outils

Slides, code & other materials provided by speaker

• Slides