Government
18F content guide
11 rules across 5 topics, naming 82 terms.
- 4 errors
- 7 warnings
- 0 suggestions
- The guide
- contribute.jquery.org
- Rules from
- testthedocs/18F
- Read at
- 274d3b5
- License
- MIT
The guide, by topic
Select a rule to see what it asks for.
Word choice
4 rules · preferred terms, jargon, and words to avoidAges Brands 15 Clarity 20 Terms 11
Voice and tone
1 rule · person, tense, contractions, and claimsContractions 34
Punctuation
3 rules · commas, dashes, quotes, and spacingOxford comma Quotes Spacing
Headings
1 rule · capitalization and punctuation in titlesTitles
Abbreviations
2 rules · acronyms, latin, and periodsAbbreviations 7 Unexpanded acronyms
The word list
Every term this guide’s rules name, and what it says to write instead.
| Instead of | Write | Rule |
|---|---|---|
| advancing | Avoid using 'advancing.' | |
| agenda | Avoid using 'agenda' (unless you’re talking about a meeting). | |
| are not | aren't | |
| back-end | 'back end' | |
| Band-Aid | bandage | |
| Bubble Wrap | packaging bubbles | |
| cannot | can't | |
| Chapstick | lip balm | |
| citizen | 'people' or 'The public' | |
| combating | 'working against' or 'fighting' | |
| commit | Be more specific — we’re either doing something or we’re not. | |
| could not | couldn't | |
| countering | 'answering' or 'responding' | |
| Crayola | crayons | |
| D.C. | DC | |
| deploy | Avoid using 'deploy' (unless you’re talking about the military or software). | |
| dialogue | 'speaking(ing)' | |
| did not | didn't | |
| disincentivize | Avoid using 'disincentivize.' | |
| do not | don't | |
| does not | doesn't | |
| dropdown | 'drop-down' or 'drop down' | |
| Dumpster | waste container, trash container | |
| eg | e.g., | |
| empower | Avoid using 'empower.' | |
| execute | 'run' or 'do' | |
| focusing | Avoid using 'focusing.' | |
| foster | Avoid using 'foster' (unless it’s children). | |
| has not | hasn't | |
| have not | haven't | |
| Hi-Liter | highlighting marker | |
| how is | how's | |
| how will | how'll | |
| ie | i.e., | |
| illegal aliens | 'undocumented immigrants' | |
| incentivize | Avoid using 'incentivize.' | |
| innovative | Use words that describe the positive outcome of the innovation. | |
| iPod | MP3 player | |
| is not | isn't | |
| it is | it's | |
| it will | it'll | |
| key | Avoid using 'key' (unless it unlocks something). | |
| Kleenex | tissue | |
| leverage | Avoid using 'leverage' (unless you're using it in the financial sense). | |
| open-source | 'open source' | |
| Plexiglas | plastic glass | |
| Post-it note | adhesive note | |
| progress | What are you actually doing? | |
| promote | Avoid using 'promote' (unless you’re talking about an ad campaign). | |
| Q-Tips | cotton swabs | |
| Scotch tape | transparent tape | |
| should not | shouldn't | |
| simple | 'straightforward', 'uncomplicated', or 'clear' | |
| streamline | Avoid using 'streamline.' | |
| strengthening | Avoid using 'strengthening' (unless you’re referring to bridges or other structures). | |
| Styrofoam | plastic foam | |
| tackling | Avoid using 'tackling' (unless you’re referring to football or another contact sport). | |
| Taser | stun gun | |
| that is | that's | |
| that will | that'll |
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