Writing docs in your IDE – an AsciiDoc primer

Writing docs in your IDE – an AsciiDoc primer

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 a development environment, an IDE plugin provides editor support and preview pane. Participants work in small groups using a web-based collaborative editor or their local IDEs. With small katas they will learn how to format text, structure documents, use images and embed diagrams. The workshop closes with a Q&A session to share best practices that participants can apply to their projects.