Ensuring that Documentation is a First-class Citizen in OS Projects
summary
Projects require an explicit claim: documentation lives in the top-level repo and a documentation milestone enforced blocks releases and merge requests until docs update. Teams add an edit this page button that opens the file for quick fixes, run two hackathons per release cycle and participate in Write the Docs writing days that yield over 40 first-time contributions. Tooling (readthedocs, PDFs), checklists for “definition of done,” and tracked JIRA tasks prove the approach actually increases docs merges and visibility.
AI-written summary · about
chapters (21)
- 0:00Introduction
- 0:36Agenda
- 1:51Why is documentation important
- 2:34Common challenges
- 4:06What we achieved
- 4:55Working with documentation
- 6:21Documentation templates
- 7:25Documentation is like government funding
- 14:04Documentation contribution process
- 18:03Recognitions
- 20:19Events
- 24:36Right to Docs
- 27:17Documentation Hackathons
- 29:01General Comments
- 30:04Summary
- 32:51Metrics
- 34:51Documentation Audits
- 37:51People who know nothing about Git
- 40:36Questions
- 41:31Format
- 43:46Community Challenges
related talks
24mWho Writes the Docs?
19mBuilding Trust Across Teams Through Documentation
10mCan we NOT do docs at the eleventh hour? Mmmmmaybe.
18mContinuous Documentation Manifesto
44mCreating a Culture of Documentation
44mPushing documentation (so it doesn't hurt anymore)
39mDevelopers Documentation: your hidden strength
47mThe Things You Don't Want to Write - Documentation