Helping Your Community Contribute to Developer Documentation
summary
Platform.sh builds an open docs site on GitHub and runs a docs as code editorial workflow: ticket → PR → developer + writer review → merge → continuous integration to staging and prod. Contribution ranges from quick typo fixes via the feedback block (smiley + comment) to full topic PRs; the site grows from about 200 topics, with early velocity of one–two new topics/week dropping to one–two/month. Templates, a style guide, and transparent issues reduce friction; automated tests cover format and examples while spelling stays manual.
AI-written summary · about
chapters (16)
- 0:00Introduction
- 0:57Team and Community
- 3:50Our Process
- 8:59Our Tools
- 16:40Our Communication Channels
- 24:55Review bottlenecks
- 25:56Priority
- 26:39Types of checks
- 27:14Why didnt spelling check work
- 27:42How to deal with frequent questions
- 28:26Documentation overview
- 29:23How many writers do you have
- 30:06Managing your work
- 30:40Collecting feedback
- 31:55How long did it take
- 33:03Whats next
related talks
39mOpen Docs, Open Collaboration: Building Better Documentation with Community PRs
39mBecome a Contributor to Microsoft Docs
46mContribute to Docs Like A Microsoft Insider
16mContributing to the Angular Docs
29mThe Technical Writers Guide to Contributing to Open Source Projects
38mA beautiful arrangement: Gaining experience & giving back through open source docs
39mCommunity and Contributors Panel
45mDocs That Scale: Strategies for Sustainable Documentation in Open Source Projects