Back to 2015-proposals
Title: Agile Documentation with Asciidoctor
Proposer: Schalk Cronjé
Type: Workshop
Duration: 90 mins
Description:
In many cases documentation are a necessity, but many documentation initiatives that are decoupled from software can become hard to maintain. Traditional word-processing software are also not fit for purpose and the traditional stalwart of open-source, DocBook, is a difficult markup language to master. In the last number of years, Github has popularised Markdown as a way to simplify document writing, but Markdown still has limitations for the writing of more extensive documentation. Step to the fore Asciidoc, a format that is increasingly popular with many projects and is akin to 'Markdown on steroids'. Now it is possible to create TOCs, reference sections, tables etc. with ease, yet maintain a consistent look and feel. Adding the ability to create HTML, PDFs and more from a single source adds to the appeal.
This will be a kickstart session, showing attendees the power of Asciidoc & Asciidoctor, how the syntax works and how to generate various kinds of documents. Various supporting tools will also be discussed including the integration of document creation into the buildsystem.
Attendees should be able to leave the session equipped to create their first documents with Asciidoc or Asciidoctor.
(Please bring a laptop with a text editor)
2015:agile_documentation_with_asciidoctor
2015/agile_documentation_with_asciidoctor.txt · Last modified: 2016/06/11 14:05 by 127.0.0.1