Levels of Docs as Code
summary
Claims a Java macro processor named Jamal reads source files, evaluates macros and injects live values (versions, defaults, snippets) into AsciiDoc so documentation stays in sync with code. It runs as a maven plugin, integrates with IntelliJ preview, fetches values from pom.xml via XPath, embeds code snippets by name and line, generates diagrams via PlantUML or any external tool, and fails CI on checksum mismatches. The tool is mature, used to keep books and demos consistent and to cut repeat edits.
AI-written summary · about
chapters (13)
- 0:00Introduction
- 1:38Why Documentation is boring
- 7:09What is Documentation
- 12:00Problems with Documentation
- 13:10Language Grammar and Style
- 18:43The Power
- 22:02Demo
- 28:59Dependencies
- 35:55Version
- 40:29Summary
- 45:23Questions
- 49:02Markup languages
- 52:52Integrations
related talks
37mCode the documentation instead of documenting the code
46mAsciidoctor: because writing docs does not have to suck
47mSpice Up Asciidoctor Documentation With Java
50mContinuous and Automated Documentation Docs As Code in Practice
51mGetting started with Asciidoctor
41mStop making fool of yourself about documentation
51mDocumentation as Code (Explained to My Father)
47mDocumentation as code (explained to my dad)