Telling a Great Story on GitHub
summary
A six-month audit finds 400 repositories littered with half-finished projects and inconsistent docs; implementation of mandatory open-source guidelines, README and product-analysis templates, and a separate incubator cemetery organization curates what appears in the main org. Feed-meereenese accepts 21 submitted READMEs for free editing. Internal practices shift to README-driven development and early PRs. A GitHub survey note of 93% citing bad docs and 5,500 respondents underscores the measurable problem and the practical fixes.
AI-written summary · about
chapters (29)
- 0:00Introduction
- 3:30Open Source
- 4:04Narrative
- 4:55Why
- 5:37Sustainable
- 6:01Too busy
- 7:35Lack of prioritization
- 9:27Tools and components
- 11:38Huge problems
- 12:42Feed Me
- 13:45The Critical Path
- 14:15Culture
- 18:09Missed opportunities
- 18:59Writers are best friends
- 19:41The digging part
- 20:20What we did
- 21:05Open Source Guild Guidelines
- 21:33Incubator
- 23:27GitHub Templates
- 23:46Product Analysis
- 24:40User Research
- 26:31Patience
- 27:28Documentation
- 28:15Review Groups
- 28:33Working Backwards
- 29:12Magic in Action
- 29:54Biggest Tip
- 30:07Read the Dog
- 30:48Read Your Twitter
related talks
47mThe Art of Documentation and Readme.md
35mThe Art of Documentation and Readme.md for Open Source Projects
44mGitHub Flavored Ruby
23mWrite the Readable README
50mOpen Source Survival Guide
25mManaging a GitHub Organization: Tools, Tips, and Best Practices
19mBuilding Trust Across Teams Through Documentation
27mManaging A Healthy GitHub Community