The State of Community Documentation
summary
About 5,000 README files are scraped and analysed, showing an ecosystem with more than 55,000 addons and roughly 1,000 new add-ons a year. Findings include widespread README clutter, blueprint copy‑paste, 995 instances of unhelpful phrasings and 2,359 inconsiderate terms that risk exclusion. A pretty sick Ruby scraper extracts the corpus; health badges from ember observer surface addon maintainability; linters like ember-cli-alex and tools such as retakes catch tone and phrasing problems so documentation can be rebuilt into clear, testable pages.
AI-written summary · about
chapters (5)
- 0:00Start
- 1:16COMMUNITY DOCUMENTATION
- 14:56INCONSIDERATE WRITING
- 18:53WHAT ABOUT GENDER?
- 20:04HOW CAN WE IMPROVE IT?
