Building a style guide from the ground up: lessons learned from a lone writer
summary
Builds a small, company-specific style guide that supplements the Google Developer Documentation Style Guide, uses a Good Docs Project template, stores content in VuePress and git, and enforces rules with the Vale linter. Targets curriculum docs for a ~3–4 person team, takes eight to nine months instead of the expected three to four, lands in the team handbook, and proves easier to edit, review, and keep consistent.
AI-written summary · about
chapters (14)
- 0:00Introduction
- 3:13Why a style guide
- 7:47Dont reinvent the wheel
- 10:40Get that team buyin
- 13:47Build with tools you already have
- 16:48Plan accordingly
- 21:45Choosing a style guide
- 22:29Choosing a word list
- 23:22Localization
- 23:52Keeping the herd together
- 25:50Who else is using it
- 27:05Scope of the guide
- 29:08Inclusive language
- 30:09Why not a style guide
related talks
23mWhat They Don't Tell You About Creating New Style Guides
48mUseful and Beautiful Developer Docs and How to Create Them
45mUseful and Beautiful Developer Docs and How to Create Them
45mMaintainable Style Guides
34mThe Dream of Styleguide Driven Development
29mStyleguides are dead! Long live Styleguide-Flows!
47mEngineering Documentation
43mUseful and Beautiful Developer Docs and How to Create Them