Loading…
This event has ended. Visit the official site or create your own event on Sched.
View analytic
Wednesday, July 13 • 13:40 - 14:20
The Knowledge: Towards a Culture of Engineering Documentation

Sign up or log in to save this to your schedule and see who's attending!

For several years, Google's internal surveys identified the lack of trustworthy, discoverable documentation as the #1 problem impacting internal developer productivity. We're not alone: Stack Overflow's 2016 survey ranked ""Poor documentation"" as the #2 problem facing engineers. (insert that quote from NYC SRE here re SREs ""living and dying"" by the docs)

Solving this problem is tough. It's not enough to build tooling; the culture needs to change. Google internal engineering is attacking the challenge three ways: Building a documentation platform; integrating that platform into the engineering toolchain; and building a culture where documentation - like testing - is accepted as a natural, required part of the development process.

In this talk, we'll share our learnings and best practices around both tooling and culture, the evolution of documentation, and some thoughts about how we can transition from the creation of documents towards an ecosystem where context-appropriate, trustworthy documentation is reliably and effortlessly available to the engineers that need it.


Speakers
RM

Riona MacNamara

Staff technical writer, Google
Riona is senior staff technical writer at Google, where she has worked for 11 years, and leads the team that builds g3doc, Google's internal platform for engineering documentation, used by thousands of projects within the company. Before Google, she worked at Amazon and spent almost... Read More →


Wednesday July 13, 2016 13:40 - 14:20
Lansdowne