•  

How GitHub uses GitHub to document GitHub

A session at Write the Docs North America

Tuesday 19th May, 2015

2:30pm to 3:00pm (PST)

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

About the speaker

This person is speaking at this event.
Garen J. Torikian

I inhale and exhale.

Sign in to add slides, notes or videos to this session

Tell your friends!

When

Time 2:30pm3:00pm PST

Date Tue 19th May 2015

Short URL

lanyrd.com/sdmwxc

Official event site

www.writethedocs.org/…

View the schedule

Share

See something wrong?

Report an issue with this session