Stop making fool of yourself about documentation
summary
Argues for writing docs as plain AsciiDoc source under version control so docs update with code, showing commands and tools that actually work: gem install asciidoctor, an Asciidoctor Docker image, Maven/Gradle plugins and a Confluence publisher. Demonstrates live inclusion of code ranges, autogenerated snippets from tests, PlantUML diagrams, HTML5/PDF/EPUB outputs via Asciidoctor PDF, syntax highlighting, and CI wiring that pushes rendered docs on git push so documentation stays current and testable.
AI-written summary · about
chapters (16)
- 0:00Intro
- 0:33What do you do
- 2:19Where is my documentation
- 2:36Not up to date always
- 3:17UML diagrams
- 3:52Versioning
- 4:52Apollo
- 5:44AskLoto
- 8:30Open Source
- 11:08Focus
- 11:36AskADoctor
- 17:31Maven Gradle
- 18:05Greater
- 18:24Maven
- 22:18Docker Container
- 24:52Documentation
related talks
46mAsciidoctor: because writing docs does not have to suck
50mContinuous and Automated Documentation Docs As Code in Practice
25mDocumentation as Code, Where to Start?
44mPushing documentation (so it doesn't hurt anymore)
47mDocumentation as code (explained to my dad)
51mDocumentation as Code (Explained to My Father)
35mThe practical implementation of Documentation as Code
37mCode the documentation instead of documenting the code