Code the documentation instead of documenting the code
summary
Argues that documentation should be treated as executable artifacts: a Java open‑source tool (Apache‑licensed Jamal macro language) fetches real snippets and the pom version into AsciiDoc/Markdown, inserts numbered, linked code samples, renders PlantUML/remote diagrams, and checks hashes so build fails when docs drift. Demo shows IntelliJ/AsciiDoctor integration, CI execution, and replacement of copy‑paste with document as code macros that include Jamal macro language and pom version auto-fetch automation.
AI-written summary · about
chapters (9)
- 0:00Introduction
- 1:02Why documentation is often ignored by developers
- 2:50Document as code
- 4:58Docs as code vs traditional
- 7:30Automating docs updates with Jamal
- 13:09Jamal macro language
- 16:04Live Jamal demo with IntelliJ and AsciiDoc
- 31:18Key takeaways
- 33:09Q&A
related talks
01h 00mLevels of Docs as Code
41mStop making fool of yourself about documentation
46mAsciidoctor: because writing docs does not have to suck
35mThe practical implementation of Documentation as Code
44mPushing documentation (so it doesn't hurt anymore)
50mContinuous and Automated Documentation Docs As Code in Practice
51mDocumentation as Code (Explained to My Father)
47mDocumentation as code (explained to my dad)