Follow the documentation-as-code approach: Write documentation in your IDE, collaborate with other developers and writers using version control and let a continuous integration server scrutinize and publish your docs.
AsciiDoc is a lightweight markup language that translates for example to HTML and PDF. In your development environment, an IDE plugin provides editor support and preview pane. Every commit to your version control system not only enhances your program, but also your architecture, developer or user documentation.
After a short introduction to AsciiDoc this talk shows how to edit and structure content in a development environment. Live examples show how to work with the AsciiDoc in the IDE and the build process.
Participants can use a URL to try out small AsciiDoc examples in their local browsers during the talk. Of the 30 minutes total talk time at the EclipseCon I plan to use 15 minutes for an interactive Q&A.
This session is independent of the programming language people use their projects as documentation is a universal topic in all projects. Users will see how information can be captured in AsciiDoc and can compare it to other markup languages, wikis or office formats.