Going Modular: Teaching Old Docs New Tricks
summary
Proposes turning big, feature‑heavy books into small, reusable units: self-contained concept and procedure modules that combine into user‑story assemblies, with modular templates on GitHub to enforce consistency. Claims this cuts content and maintenance, speeds updates for frequently deployed software, and makes onboarding easier by letting contributors pick low‑risk modules. Describes a metadata‑driven, dynamic presentation layer and notes there are working assembly+module model patterns and self-contained procedure modules with proof‑of‑concept implementations, not yet fully productionized.
AI-written summary · about
chapters (11)
- 0:00Start
- 0:43Terminology
- 12:01Modular Writing
- 12:33Templates
- 18:39Assemblies and Modules
- 21:10Prerequisites
- 21:32Concept Module
- 22:09Procedure Modules
- 24:32Additional Resources
- 25:51Modular Presentation of the Documentation
- 30:16Cutting Down on the Amount of Content
related talks
35mThe practical implementation of Documentation as Code
45mDocs or it didn't happen!
32mAbundant with life: docs beyond the wall
52mTechnically Speaking: improve your code with documentation
55mThe Emperor Has No Docs
59mTransforming your Documentation Process
46mSave a Dev, Write Documentation!
36mTo document, or not document that is the question