8 rules · preferred terms, jargon, and words to avoid
Case sensitive terms 337
Do not use terms 18
Release notes 2
Spelling
Terms errors 457
Terms suggestions 44
Terms warnings 67
Using
Concision
5 rules · long sentences, filler, and wordy phrases
Obvious terms 6
Readability grade
Repeated words 2
Sentence length
Simple words 107
Voice and tone
5 rules · person, tense, contractions, and claims
Conjunctions 4
Contractions 34
Passive voice 177
Product centric writing
Self referential text 6
Inclusive language
1 rule · gendered, ableist, and loaded terms
Conscious language 4
Punctuation
8 rules · commas, dashes, quotes, and spacing
Ellipses 2
Em dash 2
Hyphens 226
Oxford comma
Slash
Smart quotes 2
Spacing 2
Symbols 2
Headings
3 rules · capitalization and punctuation in titles
Heading punctuation
Headings
No gerunds in titles
Abbreviations
2 rules · acronyms, latin, and periods
Abbreviations
Definitions
Source hygiene
5 rules · leftovers that should not ship
Git links 2
Merge conflict markers 3
Pascal camel case 4
Session id
User replaced values 2
The word list
Every term this guide’s rules name, and what it says to write instead.
Instead of
Write
Rule
10BASE-2
10BASE2
TermsErrors
10BASET
10BASE-T
TermsErrors
24/7
24x7
TermsErrors
32-bit Windows operating system
Windows 32-bit operating system
TermsErrors
a number of
several
TermsErrors
A-MQ
AMQ
CaseSensitiveTerms
abort
cancel
TermsErrors
above
earlier
TermsSuggestions
absent
none
SimpleWords
abundance
plenty
SimpleWords
ac
AC
TermsErrors
accelerator key
keyboard shortcut
TermsErrors
accentuate
stress
SimpleWords
accompany
go with
SimpleWords
accomplish
carry out
SimpleWords
accorded
given
SimpleWords
accordingly
so
SimpleWords
accrue
add
SimpleWords
accurate
right
SimpleWords
ACK
Do 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".
DoNotUseTerms
acknowledgement
acknowledgment
TermsErrors
acquiesce
agree
SimpleWords
acquire
get
SimpleWords
ad-hoc
ad hoc
Hyphens
adapter card
adapter
TermsErrors
adaptor
adapter
TermsErrors
addon
add-on
Hyphens
addons
add-ons
Hyphens
addressees
you
SimpleWords
adjacent to
next to
SimpleWords
adjustment
change
SimpleWords
administrate
administer
TermsErrors
admissible
allowed
SimpleWords
advantageous
helpful
SimpleWords
advise
tell
SimpleWords
adviser
advisor
TermsErrors
afterwards
afterward
TermsSuggestions
aggregate
total
SimpleWords
air wall
air gap
TermsErrors
aircraft
plane
SimpleWords
aka
also known as
TermsErrors
all caps
uppercase
TermsSuggestions
all caps
uppercase
TermsWarnings
alleviate
ease
SimpleWords
allocate
assign
SimpleWords
alphameric
alphanumeric
TermsErrors
alphanumerical
alphanumeric
TermsErrors
alternatively
or
SimpleWords
alternatives
choices
SimpleWords
am
AM
TermsErrors
ameliorate
improve
SimpleWords
amend
change
SimpleWords
amongst
among
TermsErrors
analogue
analog
TermsErrors
analyse
analyze
TermsErrors
and/or
Do 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.
DoNotUseTerms
ansible
Ansible
CaseSensitiveTerms
Ansible playbook
Ansible Playbook
CaseSensitiveTerms
Ansible rulebook
Ansible Rulebook
CaseSensitiveTerms
anticipate
expect
SimpleWords
Show more (939 left)
These rules run in Vale, which checks a whole documentation set against a guide in your editor and on every pull
request.