Company
Splunk style guide
66 rules across 7 topics, naming 229 terms.
- 3 errors
- 61 warnings
- 2 suggestions
- The guide
- docs.splunk.com
- Rules from
- splunk/vale-splunk-style-guide
- 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 avoidAmpersand Backend frontend adj Data singular Decimals 2 Device agnosticism 8 Directional language 4 Dont use 20 Drilldown adj n Drilldown verb Enable 4 Failover adj n Failover verb Fractions 7 Future tense 4 Inclusive language 12 Install adj n Keyboard shortcuts 15 Lookup adj n Lookup verb Lowercase x 7 Measurement 4 Number at start of sentence Numbers 9 Out of the box 3 Parentheses 2 Phone numbers 2 Plugin adj n Plugin verb Possessives 8 Product terminology Pronouns 4 Realtime Recommendations 4 Repetition Right angle bracket Splunk products 13 Stack Subjunctive mood 10 Third-party 2 Time Time format 7 Unit capitalizations 9 User focus 13 Version Word list 102
Voice and tone
2 rules · person, tense, contractions, and claimsPassive voice 181 We 6
Inclusive language
1 rule · gendered, ableist, and loaded termsBias free language 7
Punctuation
10 rules · commas, dashes, quotes, and spacingDashes 3 Exclamation points Hyphenation 7 Optional plurals Oxford comma Quotes punctuation Quotes types Semicolon Sentence spacing 3 Trademark symbols 3
Headings
2 rules · capitalization and punctuation in titlesHeading capitalization Heading punctuation
Numbers and dates
2 rules · dates, times, units, and ordinalsDates 4 Ranges
Abbreviations
4 rules · acronyms, latin, and periodsAcronyms Latin 7 Latin etc 2 Periods in acronyms
The word list
Every term this guide’s rules name, and what it says to write instead.
| Instead of | Write | Rule |
|---|---|---|
| 3rd party | Avoid it | |
| 3rd-party | Avoid it | |
| a.k.a. | Avoid it | |
| abnormal | atypical or not typical | |
| abort | force quit, cancel, fail, close, stop, or end | |
| above | Avoid it | |
| above | 'higher' for software; 'earlier' or 'previous' for doc locations | |
| ad hoc | if needed | |
| ad-hoc | if needed | |
| add-On | add-on | |
| add-Ons | add-ons | |
| Agent's | Avoid it | |
| aka | Avoid it | |
| allows you to | Avoid it | |
| and/or | Avoid it | |
| at present | now | |
| at this point | Avoid it | |
| basic steps | steps | |
| be sure to | make sure | |
| below | Avoid it | |
| below | 'lower' for software; 'following', 'later', or 'next' for doc locations | |
| blacklist | deny list, reject, deny, or exclude | |
| boolean | Boolean | |
| bulletproof | safe, secure, solid, or impenetrable | |
| can not | can't | |
| carriage return | line break | |
| check out | see | |
| checkbox | check box | |
| choose | select | |
| click | select | |
| Cmd | Command | |
| Collector's | Avoid it | |
| Connector's | Avoid it | |
| could | Avoid it | |
| could | can | |
| could not | Avoid it | |
| couldn't | Avoid it | |
| Ctrl | Control | |
| DA | add-on | |
| dark mode | dark theme | |
| data base | database | |
| data set | dataset | |
| datapoint | data point | |
| Del | Delete | |
| demonstrate | show | |
| desire | want | |
| dialogue box | dialog box | |
| disable | deactivate, deselect, hide, inactive, turn off | |
| disabled | deactivated, deselected, hidden, turned off, unavailable | |
| disables | deactivates, deselects, hides, turns off, makes unavailable | |
| double-check | check or make sure | |
| dummy data | placeholder data | |
| e.g. | for example | |
| eight | 8 | |
| enable | Avoid it | |
| enabled | Avoid it | |
| enables | Avoid it | |
| enables you to | Avoid it | |
| enabling | Avoid it | |
| end point | endpoint |
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