While the purpose of many SmartSuite fields is self-explanatory, there are times when it would be useful to have help text to guide users in providing the correct information or selecting the right value.
Plan Availability | All plan types |
Permissions | General Access: Can view help text. Solution Owners, Administrators: Can add and modify help text. |
Related Reading |
Fields that support help text
Most SmartSuite field types support help text. Due to the way they are displayed, a small handful of "system" fields (the ones SmartSuite automatically creates and controls) do not support help text. They include:
Record Title
Comment Count
First Created
Last Updated
Adding or modifying help text
To add help text to a field:
Select the field dropdown for the field you want to add help text to
Select Modify Field Settings option.
Select the Help Text tab
Enter up to 700 characters of help text.
Note: Our help text supports rich text capabilities! Highlight text or use the bar across the top to apply formatting such as bold, highlight color, lists, and even hyperlinks!
Here is an example of a more robust paragraph of help text:
5. Choose your (Record View) display type
6. Click Update Field to save your changes
Modifying Help Text
To modify field help text, simply follow the same steps as adding help text, making your updates.
Save your changes.
Viewing Help Text
Depending on the display type selected, you will be able to see the help text as either a hoverable tooltip or as a short paragraph of text below the field name.
You can do this in the field settings under the "Help Text Appearance" Section.
As a Tooltip
Below the Field Name
Removing help text from a field
To remove field help text, simply to go Modify Fields Settings in the field dropdown, delete the help text, and update the field. You'll know you've deleted everything when the words Write Here are displayed.
Practical Scenarios and Use Cases
1. Form Guidance
Scenario: A company collects feedback via a SmartSuite form and wants users to enter specific details.
Solution: Add help text to clarify required fields, like "Please describe your experience in at least 100 words."
2. Data Accuracy
Scenario: A sales team needs to log revenue figures correctly.
Solution: Use help text to guide format entry, e.g., "Enter the amount in USD without commas or currency symbols."
3. Workflow Simplification
Scenario: New employees need to update task statuses but are unfamiliar with field meanings.
Solution: Add help text for dropdown fields explaining each status option.