How to Submit Feedback

aprity uses your feedback to improve the quality of generated documentation over time. This guide explains how to submit different types of feedback.

Prerequisites

• At least one completed scan must exist in your org.

Steps

1. Open the aprity app in Salesforce.
2. Navigate to the Feedback tab.
3. Click New Feedback.
4. Select the target type:
   • Business Rule -- feedback on a specific automation rule's documentation
   • Overview Field -- feedback on an object overview or summary field
5. Select the object the feedback applies to.
6. If applicable, select the specific chapter or section.
7. Choose the feedback kind:
   • Correction -- the documentation contains an error
   • Rejection -- the generated content is irrelevant or wrong
   • Addition -- something is missing from the documentation
   • Clarification -- the wording is unclear or confusing
8. Enter your feedback text with as much detail as possible.
9. Optionally add a Comment with additional context (up to 2000 characters).
10. Click Save.

info

Feedback is processed asynchronously. Improvements are reflected in subsequent scans, not retroactively applied to existing documentation.

Feedback Best Practices

• Be specific about what is incorrect or missing.
• Reference the exact section, field, or rule name when possible.
• For corrections, include what the correct information should be.
• Submit one feedback item per issue rather than combining multiple concerns.

Viewing Submitted Feedback

All submitted feedback appears in the Feedback tab list view. You can filter by:

• Status (All, Active, Archived, Superseded)
• Target type
• Object name

Each entry shows a Pending or Applied badge indicating whether the feedback has been consumed by a completed scan.

tip

Feedback of type Correction has the highest impact. When you correct a specific rule description, aprity prioritizes that correction in the next scan.