The Documentation Dream: One Team, No Silos, Shared Goal
summary
Teams adopt docs-driven testing and docs-as-code workflows at Red Hat projects like Foreman and Infinispan, with writers in sprint planning, QE validating a Keycloak authentication setup and discovering the workflow is so complex it triggers a UI redesign, and Data Grid docs moved into the code repo built by GitHub Actions with Jenkins syncing downstream. Writers use git, precommit hooks and an IBM-style linter, cope with a common 1:10 writer to developer ratio, and report faster feedback and fewer stale screenshots.
AI-written summary · about
chapters (9)
- 0:00Intro to docs-inclusive teams
- 6:18Docs drive design and testing
- 11:23Doc-driven testing success
- 14:14Doc-driven development workflows
- 17:05Docs as code benefits
- 19:13Moving docs upstream
- 23:48Docs as code challenges
- 27:24Summary: docs-inclusive teams
- 29:11Q&A on writing and collaboration
related talks
25mBuilding Docs like Code: Continuous Integration for Documentation
47mEngineering Documentation
59mTransforming your Documentation Process
26mEvolution of Product Documentation
44mPushing documentation (so it doesn't hurt anymore)
36mAgile documentation: A first class citizen
28mGood Enough at Scale: Documentation Infrastructure Under Capacity Constraints
28mCrossing the Streams: Enabling Collaboration Between Products and Upstreams