~/talk

The Knowledge: Towards a Culture of Engineering Documentation

Talkat SREcon16 Europe · 2016-07-11..07-13· [documentation, developer-experience]
slides:none on file

Google finds 48% of engineers cite missing trustworthy docs and discovers 137,000 internal Sites with 90% unused, so engineers embed markdown docs next to code in the monorepo and serve them via a renderer at predictable URLs. The project g3doc ships server-side rendering, IDE links, search and integrations; adoption climbs from a few pilot sites to ~10,000 projects, 17,000 authors, 200k files, 200k change lists, 3.9M monthly page views, and 30% of doc edits land with code — a clear reduction of friction and rising maintenance.

AI-written summary · about

  1. 0:00Start
  2. 0:49Engineering Documentation
  3. 2:03Problems with Engineering Documentation
  4. 8:23Why Did this Project Start
  5. 20:34Meaningful Integrations with Workflow Tools
  6. 22:03Page Info
  7. 25:42Core Values
  8. 30:14Virtuous Change Lists
  9. 32:53Tooling Comes First
~/search
type to search 6,249 conferences, 138,987 speakers and 185,172 talks
~/help
cmdctrl k
search every conference, speaker and series
/
focus the filter search
h
home
c
conferences
s
speakers
e
series
t
light / dark — the status bar button does the same
?
this help
esc
close this, then clear every filter — or just the search, while you are typing in it

Ignored while you are typing. Pages without a filter rail have no search to focus.