OSS Docs and How to Scale Them: Common Themes From the CNCF Ecosystem
summary
CNCF data shows a three-person docs team supports 140+ projects and large projects like Kubernetes have ~400 pages per language, so documentation needs differ by size: extra-small projects should pick the least cumbersome toolchain (Hugo/Netlify starter, Docusaurus-ish or Doxy), prioritize content completeness over grammar, medium projects adopt templates and good-first-issues and consider Vale linting, large projects require dedicated technical writers, ownership policies, versioning, localization and automation (release notes, CLI/API extraction).
AI-written summary · about
chapters (19)
- 0:00Intro
- 0:23Welcome
- 1:40Overview
- 3:00Documentation Services
- 4:30Small Projects
- 5:48Tooling
- 8:15Content
- 10:49Mediumsized projects
- 11:24Content quality
- 12:25Information architecture
- 14:58Technical writing
- 19:12CNCF projects
- 19:52Large projects
- 20:56Ownership
- 24:25Automations
- 26:48NP Hard Problems
- 27:34Technical Writer Absence
- 30:35Resources
- 31:59Balance
related talks
32mBridge the Gap To OSS Adoption With Documentation: A Kubernetes Story
45mDocs That Scale: Strategies for Sustainable Documentation in Open Source Projects
43mFOSS DOCS 101 (keep it simple, present!)
33mOSS Documentation Workshop
40mDocs Tools for OSS Maintainers
56mEffective Documentation: The Key to Open Source Growth
39mOpen Docs, Open Collaboration: Building Better Documentation with Community PRs
29mMeasuring Documentation Success in Open Source