Vale CMS Need more than a rule playground? Explore

Company

Google developer documentation style guide

36 rules across 7 topics, naming 125 terms.

  • 15 errors
  • 12 warnings
  • 9 suggestions
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 avoid

Voice and tone

8 rules · person, tense, contractions, and claims

Inclusive language

2 rules · gendered, ableist, and loaded terms

Punctuation

11 rules · commas, dashes, quotes, and spacing

Headings

2 rules · capitalization and punctuation in titles

Numbers and dates

5 rules · dates, times, units, and ordinals

Abbreviations

3 rules · acronyms, latin, and periods

The word list

Every term this guide’s rules name, and what it says to write instead.

Instead ofWrite
3-D3D
abovepreceding
account nameusername
action barapp bar
adminadministrator
AjaxAJAX
alumnaegraduates
alumnusgraduate
androidAndroid
Android deviceAndroid-powered device
API explorerAPIs Explorer
applicationapp
approx.approximately
are notaren't
authNauthentication
authoressauthor
authZauthorization
autoupdateautomatically update
bestAvoid it
break-glassAvoid it
cannotcan't
cellular datamobile data
cellular networkmobile network
centreAvoid it
chapterdocuments
check boxcheckbox
CLIcommand-line tool
click onclick
CloudGoogle Cloud Platform
colourAvoid it
Container EngineKubernetes Engine
content typemedia type
could notcouldn't
curated rolespredefined roles
currentlyAvoid it
data aredata is
Developers ConsoleGoogle API Console
did notdidn't
do notdon't
does notdoesn't
e-mailemail
e.g.for example
ephemeral IP addressephemeral external IP address
fastestAvoid it
fewer dataless data
file namefilename
firewallsfirewall rules
functionalitycapability
fwiwAvoid it
Google accountGoogle Account
Google accountsGoogle Accounts
Googlingsearch with Google
grayed-outunavailable
has nothasn't
have nothaven't
he/sheAvoid it
how ishow's
HTTPsHTTPS
i.e.that is
I'mAvoid 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