Need more than a rule playground?

Explore Vale CMS
Package Explorer

Salesforce

A Vale-compatible implementation of the Salesforce Writing Style Guide.

Source style

Getting started

Add it to your .vale.ini, then run vale sync.

Packages = Salesforce

[*.md]
BasedOnStyles = Vale, Salesforce

Rules 28

5 error23 suggestion
  • Salesforce.AppExchange suggestion existence Style guide

    Use 'AppExchange' (one word, capital A and E) instead of '%s'.

  • Salesforce.Application suggestion existence Style guide

    Use 'Salesforce' instead of '%s'.

  • Salesforce.BoldButtonText error existence scope: raw

    Use bold text when referring to buttons, such as Click **Save**.

  • Salesforce.Checkbox error existence Style guide

    'Checkbox' is one word.

  • Salesforce.CustomerSupport error existence

    Capitalize 'Customer Support' and use it with the company name, for example 'Salesforce Customer Support'.

  • Salesforce.Databasecom suggestion existence Style guide

    Use 'Database.com' instead of '%s'.

  • Salesforce.Datasheet suggestion substitution Style guide

    '%s' is one word. Don't split it into two words.

  • Salesforce.Deprecated suggestion existence Style guide

    Don't use 'deprecated' for a feature that's available but no longer supported. Use 'not supported' instead.

  • Salesforce.Desupported suggestion existence Style guide

    Don't use 'desupported' for a removed feature. Use 'no longer available' instead.

  • Salesforce.Editions suggestion existence Style guide

    Capitalize both words in an edition name, for example 'Enterprise Edition'. Found '%s'.

  • Salesforce.Hover suggestion substitution Style guide

    Use '%s' to describe moving the pointer over an element, not 'mouse over'.

  • Salesforce.ListElementTypes error existence Style guide

    Write 'click **Save**', not 'click the **Save** button'. Similarly, do not write '%s'.

  • Salesforce.ListViews suggestion existence Style guide

    '%s' is a Salesforce component. Capitalize it, for example 'List View' or 'List Views'.

  • Salesforce.MouseTerminology suggestion existence Style guide

    Don't use '%s'. Use 'click' instead.

  • Salesforce.Multitenant suggestion existence Style guide

    Spell 'multitenant' as one word instead of '%s'.

  • Salesforce.ObjectManager suggestion existence Style guide

    Capitalize 'Object Manager' (and use the article 'the') instead of '%s'.

  • Salesforce.Org suggestion existence Style guide

    Use 'Salesforce org' (or 'org') instead of '%s'.

  • Salesforce.Picklist suggestion existence Style guide

    Use 'picklist' (one word) instead of '%s'.

  • Salesforce.RichTextArea suggestion existence Style guide

    '%s' is a Salesforce component. Capitalize it as 'Rich Text Area'.

  • Salesforce.SalesforceAdmin suggestion existence Style guide

    Use 'Salesforce admin' instead of '%s'. Note: For UI text and login documentation, use 'Salesforce administrator'.

  • Salesforce.SalesforceHelp suggestion existence Style guide

    Use 'the Salesforce Help' instead of '%s'.

  • Salesforce.SelectCheckbox error existence Style guide

    Use 'select' or 'deselect' when referring to a checkbox. Avoid verbs like '%s'.

  • Salesforce.Subtab suggestion existence Style guide

    Spell 'subtab' as one word instead of '%s'.

  • Salesforce.SupportAgent suggestion existence Style guide

    Use 'support agent' instead of '%s'.

  • Salesforce.SystemAdministrator suggestion existence Style guide

    Use 'Salesforce admin' instead of '%s'. Note: Use 'Salesforce administrator' for UI text and login documentation.

  • Salesforce.Trailhead suggestion existence Style guide

    Use 'Trailhead' instead of '%s'.

  • Salesforce.Unavailable suggestion existence Style guide

    Don't use '%s' for a UI state. Use 'unavailable' or 'disabled' instead.

  • Salesforce.Visualforce suggestion existence Style guide

    Use 'Visualforce' instead of '%s'.