Vale CMS Need more than a rule playground? Explore

Company

Red Hat supplementary style guide

37 rules across 8 topics, naming 999 terms.

  • 5 errors
  • 13 warnings
  • 19 suggestions
Read at
09c0343
License
MIT
Used by
11 of 355 public configs

The guide, by topic

Select a rule to see what it asks for.

Word choice

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

Concision

5 rules · long sentences, filler, and wordy phrases

Voice and tone

5 rules · person, tense, contractions, and claims

Inclusive language

1 rule · gendered, ableist, and loaded terms

Punctuation

8 rules · commas, dashes, quotes, and spacing

Headings

3 rules · capitalization and punctuation in titles

Abbreviations

2 rules · acronyms, latin, and periods

Source hygiene

5 rules · leftovers that should not ship

The word list

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

Instead ofWrite
10BASE-210BASE2
10BASET10BASE-T
24/724x7
32-bit Windows operating systemWindows 32-bit operating system
a number ofseveral
A-MQAMQ
abortcancel
aboveearlier
absentnone
abundanceplenty
acAC
accelerator keykeyboard shortcut
accentuatestress
accompanygo with
accomplishcarry out
accordedgiven
accordinglyso
accrueadd
accurateright
ACKDo not use "ACK" as acronym for "acknowledgement". When writing about the acknowledgement flag ("ACK flag") or acknowledgement packet ("ACK packet") in a TCP packet, use "ACK flag" or "ACK packet".
acknowledgementacknowledgment
acquiesceagree
acquireget
ad-hocad hoc
adapter cardadapter
adaptoradapter
addonadd-on
addonsadd-ons
addresseesyou
adjacent tonext to
adjustmentchange
administrateadminister
admissibleallowed
advantageoushelpful
advisetell
adviseradvisor
afterwardsafterward
aggregatetotal
air wallair gap
aircraftplane
akaalso known as
all capsuppercase
all capsuppercase
alleviateease
allocateassign
alphamericalphanumeric
alphanumericalalphanumeric
alternativelyor
alternativeschoices
amAM
ameliorateimprove
amendchange
amongstamong
analogueanalog
analyseanalyze
and/orDo not use "and/or". Depending on the context, use one of the following constructions: a and b, a or b, or a, b, or both.
ansibleAnsible
Ansible playbookAnsible Playbook
Ansible rulebookAnsible Rulebook
anticipateexpect

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