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 avoidTerms 179 Usage 160
Concision
1 rule · long sentences, filler, and wordy phrasesSentence length
Punctuation
3 rules · commas, dashes, quotes, and spacingDash spacing Ellipses 2 Oxford comma
Headings
1 rule · capitalization and punctuation in titlesHeadings
Abbreviations
3 rules · acronyms, latin, and periodsAbbreviations Definitions Latin 4
The word list
Every term this guide’s rules name, and what it says to write instead.
| Instead of | Write | Rule |
|---|---|---|
| a number of | several | |
| abort | cancel | |
| about | Avoid it | |
| above | Avoid it | |
| across | Avoid it | |
| actionable | Avoid it | |
| administrate | administer | |
| all caps | uppercase | |
| allow | Avoid it | |
| alpha | Avoid it | |
| alphabetic | Avoid it | |
| alphabetical | Avoid it | |
| and so on | Avoid it | |
| and/or | a or b | |
| architect | Avoid it | |
| architected | Avoid it | |
| as | Avoid it | |
| as long as | if | |
| as per | according to | |
| as well as | Avoid it | |
| assembler | Avoid it | |
| attach | Avoid it | |
| back-level | earlier | |
| below | Avoid it | |
| best-of-breed | Avoid it | |
| between | Avoid it | |
| Big Blue | IBM | |
| billion | Avoid it | |
| bitness | Avoid it | |
| black box | Avoid it | |
| blink | flash | |
| blue screen of death | stop error | |
| board | Avoid it | |
| both | Avoid it | |
| breadcrumbing | breadcrumb trail | |
| bring up | Avoid it | |
| business partner | Avoid it | |
| cache | Avoid it | |
| camel case | Avoid it | |
| canned | preplanned | |
| carry out | Avoid it | |
| case insensitive | not case-sensitive | |
| catastrophic error | unrecoverable error | |
| catch | Avoid it | |
| CBE | Common Base Event | |
| CBTS | CICS BTS | |
| central processing unit | Avoid it | |
| check | Avoid it | |
| choose | Avoid it | |
| cold boot | hardware restart | |
| cold start | hardware restart | |
| combination box | Avoid it | |
| combo box | Avoid it | |
| comes with | includes | |
| command console | Avoid it | |
| Common Base Event | Avoid it | |
| complete | Avoid it | |
| componentization | component-based development | |
| componentize | develop components | |
| comprised of | consist 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