Evolution of Product Documentation
summary
Red Hat rewrites RHEL 8 docs into user-story-based titles and a single repository, replacing 46 bulky DocBook books with reusable concept, procedure and reference modules assembled into task-focused guides. Authors (30+ writers) work on ~60 concurrent changes; CI on GitLab builds AsciiDoc + GitLab CI previews that validate every assembly so an edit to one module shows up across all impacted guides. A direct feedback widget routes comments and lets subject-matter experts contribute or patch content.
AI-written summary · about
chapters (9)
- 0:00Start
- 0:12A few words about me
- 2:35What we don't do
- 5:08What problems we have with RHEL 7 documentation
- 11:17What makes a good user story?
- 11:58Concept module
- 13:40Procedure module
- 14:39Reference module
- 16:57Continuous integration for automatic previews
related talks
39mThe Documentation Dream: One Team, No Silos, Shared Goal
30mWriting Backwards: Documenting the End-of-Life of a Product
24mRe-thinking product adoption through documentation design
28mCrossing the Streams: Enabling Collaboration Between Products and Upstreams
47mEngineering Documentation
35mFrom Code to Clarity: Collaboration with Devels when Writing Product Documentation
27mGoing from Publican to Read the Docs
30mTechnical Documentation