HCH-2449 Comment Asciidoctor peut vous aider pour votre doc | Devoxx

Comment Asciidoctor peut vous aider pour votre doc

Quickie

agTest DevOps, Agilité, Méthodologie & Tests

Paris 241

vendredi at 12:25 - 12:40

Asciidoctor est une suite d’outils complets et intuitifs de publication pour le format AsciiDoc (un langage de balisage léger au format texte semblable à Markdown ou Textile). Cette plateforme est open-source et simple à utiliser. De nombreux projets open-source (petits ou grands) l’ont adopté pour réduire les difficultés rencontrées lors de la rédaction ou la maintenance de leur documentation.

Après un rapide aperçu du langage AsciiDoc, cette présentation se concentre sur les patterns qui permettent de résoudre les problèmes liés à la documentation:

  • Comment gérer les extraits de code source et s’assurer qu’ils restent à jour
  • Comment produire plusieurs documents à partir des mêmes sources ? (en partageant des blocs de texte)
  • Quels sont les outils nécessaires et pourquoi cela a-t-il de l’importance ?
  • Comment s’assurer d’avoir des builds reproductibles pour ses documents ?
  • Comment obtenir du feedback de sa communauté, de ses utilisateurs ?

Cette présentation est basée sur des exemples provenant de l’utilisation quotidienne d’Asciidoctor par le projet Eclipse Scout et est illustré par des démonstrations.

Jérémie Bresson Jérémie Bresson

I am a software developer and an open-source enthusiastic. In my spare time I contribute different open source projects. I like learning new technologies and helping people with it. I am an enthusiastic Eclipse IDE user and I try to fight the Eclipse bashing. For documentation I am convinced by the Asciidoctor approach.