Vale CMS Need more than a rule playground? Explore

Company

Elastic docs style guide

32 rules across 7 topics, naming 313 terms.

  • 1 error
  • 15 warnings
  • 16 suggestions
The guide
elastic.co
Read at
17f708a
License
Apache-2.0
Used by
1 of 355 public configs

The guide, by topic

Select a rule to see what it asks for.

Word choice

19 rules · preferred terms, jargon, and words to avoid

Concision

1 rule · long sentences, filler, and wordy phrases

Voice and tone

1 rule · person, tense, contractions, and claims

Inclusive language

3 rules · gendered, ableist, and loaded terms

Punctuation

5 rules · commas, dashes, quotes, and spacing

Headings

1 rule · capitalization and punctuation in titles

Abbreviations

2 rules · acronyms, latin, and periods

The word list

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

Instead ofWrite
a APIan API
a FAQan FAQ
a HTMLan HTML
a HTTPan HTTP
a HTTPSan HTTPS
a IDEan IDE
a myriad ofmyriad
a RSSan RSS
a SDKan SDK
a SQLan SQL
a SSDan SSD
a SSHan SSH
a SSLan SSL
a SVGan SVG
a victim ofAvoid it
a XMLan XML
a XSSan XSS
a.k.a.Avoid it
able-bodiedAvoid it
abnormalatypical, not typical
abortstop, cancel, end
abusemisuse
acknowledgementacknowledgment
ad hocif needed
ad-hocif needed
adversely impacthurt
akaAvoid it
all acrossacross
all of all
all of a suddensuddenly
all of thesethese
all-time recordrecord
almost allmost
almost neverseldom
along the lines ofsimilar to
alumnaegraduates
alumnusgraduate
amongstamong
an adequate number ofenough
an appreciable number ofmany
an CPUa CPU
an CSVa CSV
an epilepticAvoid it
an estimatedabout
an GPUa GPU
an GUIa GUI
an JSONa JSON
an PDFa PDF
an RAMa RAM
an URIa URI
an URLa URL
an USBa USB
analyseanalyze
and higherand later
and lowerand earlier
and newerand later
and olderand earlier
and/orAvoid it
any and allall
app menuapplication menu

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