Company
Salesforce writing style guide
28 rules across 1 topics, naming 29 terms.
- 5 errors
- 0 warnings
- 23 suggestions
- The guide
- developer.salesforce.com
- Rules from
- sfadriaan/Salesforce
- Read at
- 95b2ef4
- License
- MIT
The guide, by topic
Select a rule to see what it asks for.
Word choice
28 rules · preferred terms, jargon, and words to avoidApp exchange 4 Application Bold button text 7 Checkbox Customer support Databasecom 3 Datasheet 2 Deprecated Desupported Editions Hover 3 List element types List views Mouse terminology Multitenant Object manager Org Picklist Rich text area Salesforce admin Salesforce help 2 Select checkbox Subtab Support agent 4 System administrator Trailhead 3 Unavailable 3 Visualforce 3
The word list
Every term this guide’s rules name, and what it says to write instead.
| Instead of | Write | Rule |
|---|---|---|
| admin | Avoid it | |
| App Exchange | Avoid it | |
| Appexchange | Avoid it | |
| check box | Avoid it | |
| Click Cancel | Avoid it | |
| Click Clone | Avoid it | |
| Click Delete | Avoid it | |
| Click Next | Avoid it | |
| Click OK | Avoid it | |
| click on | Avoid it | |
| Click Run Report | Avoid it | |
| Click Save | Avoid it | |
| data sheet | datasheet | |
| data sheets | datasheets | |
| database.com | Avoid it | |
| deprecated | Avoid it | |
| desupported | Avoid it | |
| dimmed | Avoid it | |
| mouse over | hover | |
| mouse-over | hover | |
| mouseover | hover | |
| rich text area | Avoid it | |
| Salesforce application | Avoid it | |
| Salesforce help | Avoid it | |
| Trail Head | Avoid it | |
| TrailHead | Avoid it | |
| uneditable | Avoid it | |
| Visual Force | Avoid it | |
| VisualForce | Avoid it |
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