Transforming your Documentation Process
summary
A panel compares concrete rewrites of doc pipelines: an internal Google platform scales to 10,000 projects and drives doc changes alongside code; Balsamiq replaces a legacy CMS with a static site built with Hugo + GitHub + S3, adds forestry.io and splits user and support sites; Rackspace consolidates five subdomains into a Deconst pipeline using Sphinx and Markdown/reStructuredText; Microsoft moves content to Markdown on GitHub with webhooks and publishes 5,000 topics live. Results show faster publishing, more contributors, and measurable co-changes of code+docs.
AI-written summary · about
chapters (24)
- 0:00Introduction
- 4:00Leons story
- 9:33Leons presentation
- 15:40Ted presentation
- 20:50John presentation
- 25:20Culture
- 28:50Small company culture
- 30:37Perception of writers
- 31:40How does our role evolve
- 32:26Side projects
- 33:07V teams
- 35:12Other tools
- 36:11Culture change
- 38:23Is it worth it
- 40:45How to measure success
- 44:15How to measure adoption
- 45:36Page analytics
- 48:57Customer support
- 49:49API Documentation
- 50:35Platform Culture
- 53:07Markdown
- 55:33Where to start
- 56:49Forgiveness vs Permission
- 57:26Dont have too many cooks
related talks
44mPushing documentation (so it doesn't hurt anymore)
25mBuilding Docs like Code: Continuous Integration for Documentation
35mThe practical implementation of Documentation as Code
36mBuilding Docs like Code: Continuous Integration for Documentation
47mEngineering Documentation
39mThe Documentation Dream: One Team, No Silos, Shared Goal
45mDocs as Code Fix a poor documentation culture in your organization
05mDocs as Part of the Product: Open Source Technical Documentation at Scale