Sharing Knowledge: Writing Good Docs for Quick Approval
summary
Led Kubernetes SIG Docs 2016–2020, argues that simple process shifts cut PR churn from weeks to hours by requiring an issue that states audience and plan, sign the CLA, and a PR that specify the kind of review (sig docs vs sig network for technical checks). Recommends content templates (Doxy, Good Docs), split docs vs technical review, reviewer rotations, actionable edits, migrate rst to mkdocs first then re‑architect, and accept “good enough” published docs.
AI-written summary · about
chapters (9)
- 0:00Introduction to docs
- 2:52The PR churn problem
- 8:43Process foundations
- 10:57Planning your documentation
- 13:11Writing techniques
- 16:35Reviewing effectively
- 20:50Key takeaways
- 23:35Resources and community
- 25:58Q&A session
related talks
32mBridge the Gap To OSS Adoption With Documentation: A Kubernetes Story
13mTechnical documentation – how can I write them better and why should I care?
45mDocs That Scale: Strategies for Sustainable Documentation in Open Source Projects
34mSIG Contributor Experience Deep Dive
18mTechnical Documentation - How Can I Write Them Better and Why Should I Care?
39mOpen Docs, Open Collaboration: Building Better Documentation with Community PRs
41mAlmost None to Some: Driving DISQO's Doc Culture as a Solo Documentarian
24mDocs Advocacy is Dev Advocacy