Salesforce Style Guide for Documentation and User Interface Text

Clouds with binary code floating aboveCloud with binary code floating above

No Results

Search Tips:

  • Please consider misspellings
  • Try different search keywords
PDF

Entity Names

Objects, such as account and opportunity, or data types, such as Lookup and Text Area, receive no special formatting. They follow different capitalization guidelines depending on their context:
  • User Interface Text: In UI text, most object names are referenced from hard-coded labels that are capitalized. In this case, use the capitalization found in the user interface. For example: Select Text Area (Long) and click Next.
  • Code: When referring to a code context such as in the API or Apex, use the capitalization found in the code itself. The names of objects and data types are capitalized in Apex documents, but are lowercase in API documents to reflect the actual values in the Apex code or the API WSDL (Web Services Description Language), respectively. For example: (API) Every custom field has a boolean data type. (Apex) Ensure that the Boolean condition remains true.
    In most cases, it’s not important to the general user whether you’re referring to the object or record (instance). Use your best judgment and clarify when necessary.

    Objects, calls, methods, soap headers, and any code element should retain its case, even if placed at the beginning of a sentence or heading. If necessary, consider rewriting a sentence that begins with an element in lower case so that the element is not the first word. Headings in reference documentation often contain elements, and the elements must retain their case.

    Note

  • End-User Documentation (Help, tip sheets, etc.): Don’t capitalize the names of Salesforce objects in general usage. For example, use the account record, not the Account record.