Skip to content

Instantly share code, notes, and snippets.

@gscheibel
Created May 18, 2015 10:06
Show Gist options
  • Save gscheibel/0f5f909d0280319d5942 to your computer and use it in GitHub Desktop.
Save gscheibel/0f5f909d0280319d5942 to your computer and use it in GitHub Desktop.
Et si on arrêtait de se prendre la tête avec la documentation
“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 !”, “Comment je génère la table des matières dans cette m**!”, “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.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment