“Is the documentation up to date?”
“Where’s the documentation for version 1.5?”
“What are the differences with the previous version?”
“How do I generate the table of contents?”
“How to generate a PDF of the documentation?”
“How can I change the styles for titles?”
“Damnit! Word again broke the numbering in my list again!”
Most of the time, the documentation is written in files that are isolated from the source code. The format can be constraining for the developer, which leads to frustration and impacts the final delivery. Taking care of the form is not our primary activity, but the content definitely is. And of course, what about seeing those difference between versions?
If this introduction sounds familiar, Asciidoctor is here for you. Simple, clear, concise. During this presentation we will see the syntax, the integration in the application lifecycle and how to customize the output. You’ll discover that writing documentation does not have to be a pain in your ass.