Skip to main content
USENIX
  • Conferences
  • Students
Sign in
  • Home
  • Programme
  • Grants for Women
  • Participate

sponsors

Gold Sponsor
Gold Sponsor
[Amazon logo]
Gold Sponsor
Silver Sponsor
Silver Sponsor
Bronze Sponsor
Bronze Sponsor
[Demonware logo]
General Sponsor

connect with us


  •  Twitter
  •  Facebook
  •  LinkedIn
  •  Google+
  •  YouTube

general information

Venue
DoubleTree by Hilton Dublin - Burlington Road
Leeson Street Upper
Dublin 4, Ireland

Questions?
About SREcon?
About Registration?
About Sponsorship?

twitter

Tweets by @SREcon

usenix conference policies

  • Event Code of Conduct
  • Conference Network Policy
  • Statement on Environmental Responsibility Policy

You are here

Home » The Knowledge: Towards a Culture of Engineering Documentation
Tweet

connect with us

The Knowledge: Towards a Culture of Engineering Documentation

Riona MacNamara, Google

Abstract: 

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.

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.

Riona MacNamara is a staff technical writer at Google. She leads Google's Documentation Infrastructure team, which aims to make internal engineers happier and more productive by fully integrating the creation, maintenance, and discovery of engineering information into our development workflow and culture. She previously worked at Amazon and Microsoft.

Riona MacNamara, Google

Riona MacNamara is a staff technical writer at Google. She leads Google's Documentation Infrastructure team, which aims to make internal engineers happier and more productive by fully integrating the creation, maintenance, and discovery of engineering information into our development workflow and culture. She previously worked at Amazon and Microsoft.

Open Access Media

USENIX is committed to Open Access to the research presented at our events. Papers and proceedings are freely available to everyone once the event begins. Any video, audio, and/or slides that are posted after the event are also free and open to everyone. Support USENIX and our commitment to Open Access.

View the slides

Presentation Video 

  • Log in or    Register to post comments

Gold Sponsors

[Amazon logo]

Silver Sponsors

Bronze Sponsors

[Demonware logo]

General Sponsors

© USENIX

SREcon is a registered trademark of the USENIX Association.

  • Privacy Policy
  • Contact Us