Skip to content

Instantly share code, notes, and snippets.

@gscheibel
Created May 18, 2015 09:55
Show Gist options
  • Save gscheibel/2374751d9cdb328ab301 to your computer and use it in GitHub Desktop.
Save gscheibel/2374751d9cdb328ab301 to your computer and use it in GitHub Desktop.
Stop making a fool of yourself with documentation
"Is the documentation up to date ?", "Where is the documentation version 1.5 ?', "What are the differences with the previous version ?" "How do I generate the table of content ?" "How to generate the documentation in PDF ?" "What is the style for titles ?" "Damn Word again broke my numbered list !"
Most of the time, the documentation is written in files completely apart from the source code. Its format can be constraining for the developer which leads to frustration and affect the final delivery. Taking care of the form is not our (main) activity but content is. And of course, what about seeing the difference between versions.
If this introduction sounds familiar so Asciidoctor is here for you. Simple, clear, concise. During this presentation we will see the syntax, the integration in the application life cycle and how to customize the output.
And you will figure out that that you don't have to make a fool of yourself with documentation
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment