Vale CMS Need more than a rule playground? Explore

Company

IBM Developer editorial style guide

10 rules across 5 topics, naming 326 terms.

  • 4 errors
  • 2 warnings
  • 4 suggestions
The guide
ibm.com
Rules from
vale-cli/IBM
Read at
80c3ccd
License
MIT

The guide, by topic

Select a rule to see what it asks for.

Word choice

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

Concision

1 rule · long sentences, filler, and wordy phrases

Punctuation

3 rules · commas, dashes, quotes, and spacing

Headings

1 rule · capitalization and punctuation in titles

Abbreviations

3 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 number ofseveral
abortcancel
aboutAvoid it
aboveAvoid it
acrossAvoid it
actionableAvoid it
administrateadminister
all capsuppercase
allowAvoid it
alphaAvoid it
alphabeticAvoid it
alphabeticalAvoid it
and so onAvoid it
and/ora or b
architectAvoid it
architectedAvoid it
asAvoid it
as long asif
as peraccording to
as well asAvoid it
assemblerAvoid it
attachAvoid it
back-levelearlier
belowAvoid it
best-of-breedAvoid it
betweenAvoid it
Big BlueIBM
billionAvoid it
bitnessAvoid it
black boxAvoid it
blinkflash
blue screen of deathstop error
boardAvoid it
bothAvoid it
breadcrumbingbreadcrumb trail
bring upAvoid it
business partnerAvoid it
cacheAvoid it
camel caseAvoid it
cannedpreplanned
carry outAvoid it
case insensitivenot case-sensitive
catastrophic errorunrecoverable error
catchAvoid it
CBECommon Base Event
CBTSCICS BTS
central processing unitAvoid it
checkAvoid it
chooseAvoid it
cold boothardware restart
cold starthardware restart
combination boxAvoid it
combo boxAvoid it
comes withincludes
command consoleAvoid it
Common Base EventAvoid it
completeAvoid it
componentizationcomponent-based development
componentizedevelop components
comprised ofconsist of

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