Documentation as code (explained to my dad)
summary
Shows a concrete workflow: write in AsciiDoc, edit in an IDE (Atom/VS Code/IntelliJ) with syntax and preview, store in Git/GitHub, review with pull requests and rich diffs, run Asciidoctor to produce PDF HTML EPUB and slides, and automate publishing via CI. Demonstrates includes/attributes to enforce DRY, use of sentence-per-line diffs to simplify merges, and custom extensions for xref checks and admonitions so large docs (thousands of pages) remain consistent and verifiable.
AI-written summary · about
chapters (12)
- 0:00Start
- 3:15Documentation as Code (explained to my dad)
- 7:04Separation of concerns
- 23:02You Get What You Get!
- 23:41Writing docs: code practices!
- 27:09IDE for writers
- 35:07Collaborating on docs: code practices!
- 36:11Pull Request
- 36:38Content Review
- 36:54Working branches
- 44:00Publishing docs: code practices!
- 44:40Continuous Integration
related talks
51mDocumentation as Code (Explained to My Father)
25mDocumentation as Code, Where to Start?
41mStop making fool of yourself about documentation
50mContinuous and Automated Documentation Docs As Code in Practice
44mPushing documentation (so it doesn't hurt anymore)
35mThe practical implementation of Documentation as Code
46mAsciidoctor: because writing docs does not have to suck
47mEngineering Documentation