Sefism is free for learners. We are here to help you grow, one step at a time.Join for free
Sefism.
Guide · Career GrowthFree

Google Developer Documentation Style Guide

Google's public style guide for developer documentation: voice and tone, formatting, code samples, procedures, API reference comments and word choice. It is the most widely used free style guide for developer docs, and Vale ships a ready-made set of rules based on it.

Format

Guide

Topic

Career Growth

Provider

Google

Time needed

Skim in an hour, consult for years

Level

All

Access

Free

What it is

The Google developer documentation style guide is the editorial guide Google uses for its developer documentation, published openly. It covers voice and tone, formatting text, writing procedures, code samples in documentation, API reference code comments, links, lists, tables, accessibility, inclusive language and a large word list of preferred terms.

The guide describes itself as guidance, not law. It suggests departing from it when doing so improves your content, and it sets an order of precedence: project-specific guidelines first, then this guide, then third-party references such as the Microsoft Writing Style Guide for technical terms and Merriam-Webster for spelling.

Why it matters

Consistency is a large part of what makes documentation feel trustworthy. A style guide means you do not decide from scratch whether to write "click" or "select", "log in" or "login", or how to format a UI label. Many teams adopt the Google guide as their base, so knowing it is directly useful at work.

For a portfolio, stating "follows the Google developer documentation style guide" and actually doing it signals professional habits. Reviewers notice consistent procedures, sentence-case headings and clear code sample introductions.

Where to start

The guide recommends starting with its highlights page, voice and tone, and text formatting. Then read:

  • Writing procedures (numbered steps, one action per step).
  • Code samples and how to introduce them.
  • API reference code comments, if you will document APIs.
  • The word list, as a reference when you are unsure.

Tools

Vale, the open source prose linter, has a published Google style package that flags many of the guide's rules automatically in your editor or CI. It will not catch everything, so treat it as a first pass.

Free vs paid

Free. The content is licensed under Creative Commons Attribution 4.0 and code samples under Apache 2.0.

Common questions

Google or Microsoft style? Either is fine. Pick one for your own work and follow the team's choice at a job. The Google guide is tuned for developer docs; the Microsoft guide covers broader product writing.

Is it only for Google products? No. Some pages carry Android or Google Cloud notes, but the general guidance applies to any developer documentation.

Should I memorise it? No. Read the highlights, then look things up as they come up.

careerapiproductivity

Ready to start?

Opens on Google in a new tab.

Open resource
Link broken or out of date?

Report a problem

With "Google Developer Documentation Style Guide". Only Tauseef reads this.

Work with me

Stuck on something specific?

Writing only gets you so far. If you want an answer to your situation rather than the general case, book a session and we will work through it together. Sessions are free for approved Sefism members, and a few slots open each week.