Company
Google developer documentation style guide
36 rules across 7 topics, naming 125 terms.
- 15 errors
- 12 warnings
- 9 suggestions
- The guide
- developers.google.com
- Rules from
- vale-cli/Google
- Read at
- a52f667
- License
- MIT
- Used by
- 85 of 355 public configs
The guide, by topic
Select a rule to see what it asks for.
Word choice
5 rules · preferred terms, jargon, and words to avoidJargon 4 Slang 5 Spelling 4 Word list 18 Word list case 54
Voice and tone
8 rules · person, tense, contractions, and claimsAnthropomorphism 2 Contractions 22 Excessive claims 4 First person 5 Passive 177 Timeless 3 We 5 Will
Inclusive language
2 rules · gendered, ableist, and loaded termsGender 3 Gender bias 35
Punctuation
11 rules · commas, dashes, quotes, and spacingColons Ellipses Em dash Exclamation Ly hyphens Optional plurals Oxford comma 2 Parens Quotes Semicolons Spacing 2
Headings
2 rules · capitalization and punctuation in titlesHeading punctuation Headings
Numbers and dates
5 rules · dates, times, units, and ordinalsAMPM 3 Date format 2 Ordinal Ranges Units 3
Abbreviations
3 rules · acronyms, latin, and periodsAcronyms Latin 2 Periods
The word list
Every term this guide’s rules name, and what it says to write instead.
| Instead of | Write | Rule |
|---|---|---|
| 3-D | 3D | |
| above | preceding | |
| account name | username | |
| action bar | app bar | |
| admin | administrator | |
| Ajax | AJAX | |
| alumnae | graduates | |
| alumnus | graduate | |
| android | Android | |
| Android device | Android-powered device | |
| API explorer | APIs Explorer | |
| application | app | |
| approx. | approximately | |
| are not | aren't | |
| authN | authentication | |
| authoress | author | |
| authZ | authorization | |
| autoupdate | automatically update | |
| best | Avoid it | |
| break-glass | Avoid it | |
| cannot | can't | |
| cellular data | mobile data | |
| cellular network | mobile network | |
| centre | Avoid it | |
| chapter | documents | |
| check box | checkbox | |
| CLI | command-line tool | |
| click on | click | |
| Cloud | Google Cloud Platform | |
| colour | Avoid it | |
| Container Engine | Kubernetes Engine | |
| content type | media type | |
| could not | couldn't | |
| curated roles | predefined roles | |
| currently | Avoid it | |
| data are | data is | |
| Developers Console | Google API Console | |
| did not | didn't | |
| do not | don't | |
| does not | doesn't | |
| e.g. | for example | |
| ephemeral IP address | ephemeral external IP address | |
| fastest | Avoid it | |
| fewer data | less data | |
| file name | filename | |
| firewalls | firewall rules | |
| functionality | capability | |
| fwiw | Avoid it | |
| Google account | Google Account | |
| Google accounts | Google Accounts | |
| Googling | search with Google | |
| grayed-out | unavailable | |
| has not | hasn't | |
| have not | haven't | |
| he/she | Avoid it | |
| how is | how's | |
| HTTPs | HTTPS | |
| i.e. | that is | |
| I'm | Avoid it |
These rules run in Vale, which checks a whole documentation set against a guide in your editor and on every pull request.
All 16 guides