Help Tips are essential in helping users quickly understand features throughout the system. Requesting new Help Tips as well as feedback on existing Help Tips is always welcomed and encouraged.
How to Submit a New Help Tip Request
All new Help Tip requests should be submitted in the Instructional Design Discussion channel located in the v3 Customer Success team.
They should be submitted as a post with the following format:
1. The subject line should include the Navigation Path that takes you directly to the screen you would like the Help Tip to be created on.
Example: Sales > Payments > Payments.
The body of the message should include the following:
2. The Reasoning should describe the need behind the Help Tip.
Example: Customer's frequently ask where refunds are and a Help Tip here could explain this is where they take place.
3. The Suggested Text should have all important information the Help Tip should include.
Example: All payments taken will be displayed here. Selecting a payment will provide you with more information as well as the option to complete a refund.
4. The Screenshot should be an image of the screen you would like the Help Tip to be on. All screenshots should also include markups that clearly direct you to exactly where on the screen the Help Tip should be.
Example:
The combination of these four parts should look similar to the example shown below.
How to Submit a Request for an Existing Help Tip
All requests for an existing Help Tip should also be submitted in the Instructional Design Discussion channel located in the v3 Customer Success team.
Similar to new Help Tip requests, they should be submitted as a post with the following format:
1. The subject line should include the Navigation Path that takes you directly to the screen where the existing Help Tip is located.
Example: Production > Settings > Time Clock Settings
The body of the message should include the following:
2. A Request explaining what needs to be changed in the Help Tip.
Example: This help tip includes "(find the report)" instead of showing the correct report.
3. A Screenshot that also includes markups that clearly direct you to exactly where the Help Tip is. If the help tip has information, please hover over the help tip and be sure the information is included in the screenshot. All incorrect information that needs to be updated should also be marked up as shown below.
Example:
The combination of these three parts should look similar to the example shown below.
Note: Anyone who does not have access to the Instruction Design Discussion channel can reach out to the Instructional Design team directly with their requests.