Contribute Media
A thank you to everyone who has made this possible: Read More

How GitHub uses GitHub to document GitHub

Description

Garen J. Torikian http://lanyrd.com/2015/writethedocs/sdmwxc/ Everyone knows that GitHub is the place to host your project's code. What you may not know is that the same workflow developers use to create, update, and manage their software is also used to create, update, and manage GitHub's documentation. https://help.github.com is GitHub's second-most viewed site--after the main website itself. I'd like to provide a somewhat opinionated look on how our valiant Documentation team writes and releases content for features on GitHub.com and GitHub Enterprise. I'll go over: How our teams (Development, Security, Docs, etc) coordinate before launching a feature The importance of opening pull requests early The review/edit cycle with peers How we incorporate DITA best practices into our Markdown documentation Validating content through CI and automated tests How we incorporate feedback from our users

Details

Improve this page