Salesforce Style Guide for Documentation and User Interface Text
jLocalization
The process of adapting the product to a particular language, culture, and desired local look and feel.
Ensure your content and user interface text is easily localizable and is grammatically
correct.
- Avoid object names in text whenever possible
- But never sacrifice usability!
- If you use object names, avoid complex grammar
- Try to make the object name the subject of the sentence, which helps
translators modify sentences while keeping phrases with renamed objects
grammatically correct. For example:
- Avoid: Companies you do business with are called accounts.
- Better: Accounts are the companies you do business with.
- Be specific
- If possible, use the specific name of the record. For example:
- Avoid: This page lists the sharing for this opportunity.
- Better: Here is the sharing for My Big Opp.
- Use record or object as a generic term if you can
rather than the standard name of the object. For example:
- Avoid: The sharing setting for this opportunity is private.
- Better: This record's sharing setting is private.
- Use whole text strings
- In the user interface text label files, avoid composing strings from multiple substrings. Use complete sentences or phrases to avoid ambiguity for the translator.
- Avoid user input elements within sentences
- Avoid using input elements, the values they contain, or their unit label to
create a sentence or phrase. Such a design isn't localizable because
sentence structure varies with language.
- Avoid: Allow the ______________ domain to send emails using Apex Email Services.
- Better: Allow this domain to send emails using Apex Email Services: ______________