Why provide in-app help on request?
Building and deploying a solution in Salesforce doesn’t guarantee that end users will automatically understand how to operate it. Even with thorough design, users often face confusion when navigating new fields, objects, or processes.
In-app help provides the critical 'just-in-time' guidance users need to feel confident in their tasks. Without this, teams risk errors, delays, and an increased dependency on support staff.
In-app help simplifies the learning process by making relevant information available in context, directly within the user’s workflow. It prevents the need to exit Salesforce to search for documentation or contact support. Instead, users get clear instructions where and when they need them, reducing friction and boosting efficiency.
Unlike more complex enablement tools that may require heavy customization or training, the Elements platform allows you to quickly transform existing documentation into actionable, accessible in-app help with minimal effort.
When to create in-app help?
In-app help is best suited for simple, contextual enablement—guiding users through straightforward tasks such as:
'How do I use this field?'
'How do I use this object?'
'Which picklist option should I choose?'
'What does this record type mean?'
You should create ad-hoc in-app help resources in the following scenarios:
When end users frequently ask how to use specific Salesforce fields, objects, or record types.
When new processes or system updates are rolled out, and users require additional guidance.
When documentation already exists in your Salesforce metadata (notes, URLs, diagrams) and can be leveraged to create immediate, in-app assistance.
To reduce dependency on formal training or third-party enablement tools.
For more complex workflows that span multiple systems or complex steps, it is more advisable to follow this separate solution guide on using Elements to train end-users in using complex systems in accordance with best practice.
Prerequisites
In order to follow this guide you need:
Salesforce Metadata Management license
Synced Salesforce Org into Metadata Dictionary
Perform: Set up and deploy in-app help
Step 1: Document your objects, field, and record types
Go to the Elements Salesforce Metadata Dictionary to locate the specific metadata components (e.g., objects, record types, fields) you want to add documentation to.
Attach human-generated documentation such as rich text notes, diagrams, or URLs directly to those components. For instance, you might add a URL linking to a video tutorial or a detailed note explaining the purpose of a field.
A lot of that documentation would be created during business process design or solution design stages.
Tip: you can import your existing knowledge into your Metadata Dictionary and store it against relevant metadata components.
Step 2: Convert documentation to in-app help
Once the relevant metadata is documented, simply click on the option to turn the documentation into in-app help from the Elements platform. This is a one-click action, converting the metadata documentation into a purple '?' icon on the Salesforce UI.
If you want to limit who can see the document, simply change the group of users associated with the document.
Documentation left against fields in Metadata Dictionary becomes available next to fields on page layouts and dynamic lightning pages. The purple '?' also appear on creation and edit screens.
Documentation left on objects in Metadata Dictionary becomes available at the top of the record page next to the object name.
Documentation left on the record types in Metadata Dictionary also becomes available at the top of the record page next to the object name but only if displayed record matches the specified record type.
The power of simplicity in in-app help
Unlike complex enablement tools, this in-app help solution is easy to set up and manage. By leveraging the documentation already available in your metadata dictionary, you can roll out personalized help quickly and efficiently.
The integration with Salesforce through the Elements managed package ensures that users have on-demand access to relevant information, helping them complete tasks faster and with fewer errors.
This lightweight, no-frills approach to enablement focuses on the essentials, offering the guidance users need without overloading them with unnecessary information. With just a few clicks, you can transform existing documentation into actionable, in-app help, making it a powerful tool for everyday support.