Vale CMS Need more than a rule playground? Explore

Company

Splunk style guide

66 rules across 7 topics, naming 229 terms.

  • 3 errors
  • 61 warnings
  • 2 suggestions
Read at
47cc21b
License
Apache-2.0

The guide, by topic

Select a rule to see what it asks for.

Word choice

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

Voice and tone

2 rules · person, tense, contractions, and claims

Inclusive language

1 rule · gendered, ableist, and loaded terms

Punctuation

10 rules · commas, dashes, quotes, and spacing

Headings

2 rules · capitalization and punctuation in titles

Numbers and dates

2 rules · dates, times, units, and ordinals

Abbreviations

4 rules · acronyms, latin, and periods

The word list

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

Instead ofWrite
3rd partyAvoid it
3rd-partyAvoid it
a.k.a.Avoid it
abnormalatypical or not typical
abortforce quit, cancel, fail, close, stop, or end
aboveAvoid it
above'higher' for software; 'earlier' or 'previous' for doc locations
ad hocif needed
ad-hocif needed
add-Onadd-on
add-Onsadd-ons
Agent'sAvoid it
akaAvoid it
allows you toAvoid it
and/orAvoid it
at presentnow
at this pointAvoid it
basic stepssteps
be sure tomake sure
belowAvoid it
below'lower' for software; 'following', 'later', or 'next' for doc locations
blacklistdeny list, reject, deny, or exclude
booleanBoolean
bulletproofsafe, secure, solid, or impenetrable
can notcan't
carriage returnline break
check outsee
checkboxcheck box
chooseselect
clickselect
CmdCommand
Collector'sAvoid it
Connector'sAvoid it
couldAvoid it
couldcan
could notAvoid it
couldn'tAvoid it
CtrlControl
DAadd-on
dark modedark theme
data basedatabase
data setdataset
datapointdata point
DelDelete
demonstrateshow
desirewant
dialogue boxdialog box
disabledeactivate, deselect, hide, inactive, turn off
disableddeactivated, deselected, hidden, turned off, unavailable
disablesdeactivates, deselects, hides, turns off, makes unavailable
double-checkcheck or make sure
dummy dataplaceholder data
e.g.for example
eight8
enableAvoid it
enabledAvoid it
enablesAvoid it
enables you toAvoid it
enablingAvoid it
end pointendpoint

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