Agile documentation: A first class citizen
summary
Claims that documentation stops being a waterfall afterthought by removing the build step and publishing straight from repo, using asciidoc rendered by asciidoctor.js and served via GitHub pages. Documentation renders inside the running cluster on OpenShift, injecting real routes and environment values, and provisioning sample services from adjacent JSON so walkthroughs resolve live URLs. Unit of work is an asciidoc walkthrough with tasks, verifications and task-specific resources, letting teams ship testable, releasable docs every sprint.
AI-written summary · about
chapters (11)
- 0:00Introduction
- 3:01Documentation in DevOps
- 6:14Removing build with AsciiDoc
- 11:07Rendering in user env
- 16:47Collaboration UX & eng
- 18:10Live demo walkthrough
- 23:20Community contributions
- 25:54Integrating docs apps
- 31:10Metadata walkthroughs
- 33:42Traditional vs agile docs
- 35:37Benefits agile docs
related talks
44mPushing documentation (so it doesn't hurt anymore)
41mStop making fool of yourself about documentation
25mBuilding Docs like Code: Continuous Integration for Documentation
50mContinuous and Automated Documentation Docs As Code in Practice
31mCreating a documentation site for users with AsciiDoc and Antora
39mWe're Agile, we don't do documentation
39mThe Documentation Dream: One Team, No Silos, Shared Goal
46mAsciidoctor: because writing docs does not have to suck