Overview
Autodoc uses AI to automatically generate field descriptions, help text, and definitions across your Salesforce environment — directly from the Data Dictionary. This article walks you through both single-column and bulk documentation workflows, and explains how to review and approve AI-generated content.
Applies to: All Salesforce objects | Feature: Autodoc (Data Governance)
Prerequisites
- Access to the Data Governance section of the application
- Permissions to edit Data Dictionary fields
- A connected Salesforce environment with at least one object configured
Estimated Time
- Setup: ~2 minutes
- Processing (bulk): ~2–3 minutes per object (runs in the background)
Step-by-Step Instructions
Option A: Document a Single Column
- Navigate to Data Governance in the main navigation and select Data Dictionary.
-
Open the object you want to document (this example uses the Opportunity object).
- Locate the AI sparkle icon (✦) at the top of the column you want to document.
- Hover over the sparkle icon to reveal the tooltip: "Generate AI content for this column."
- Click the sparkle icon. The system will generate a description, help text, or definition for each field in that column, depending on the column type.
- Review the generated content directly in the field.
Option B: Bulk Document All Fields (Recommended)
-
From the object view in Data Dictionary, click the bulk selector checkbox in the top-left corner next to Field Name.
This selects all fields — for example, all 215 fields on the Opportunity object.
- Click Edit in the toolbar. Select the checkbox under Text Field Actions.
- In the edit panel, choose which content types to generate:
- Definitions
- Descriptions
- Help Text
- Or select all three
-
Click Generate, then click Update to confirm.
-
The system kicks off a background job. A progress indicator appears at the bottom of the screen.
Note: Bulk processing takes approximately 2–3 minutes for a full object. You can navigate elsewhere in the app while the job runs — it will complete in the background.
- When the job finishes, fields that received AI-generated content display a sparkle icon (✦) next to their entry.
Reviewing and Approving AI-Generated Content
-
To review AI-generated fields, click the Filter icon and select AI Generated Descriptions.
This filters the field list to show only fields with AI-generated content.
- Click into any field to review its generated content.
- Make any edits needed — or leave the content as-is. Either action marks the field as people-reviewed: the sparkle icon is removed, and the field is logged as human-verified going forward.
Expected Results
After completing either workflow:
- Documented fields display their generated descriptions, help text, or definitions inline
- AI-generated fields are marked with a ✦ sparkle icon until reviewed
- Once reviewed, fields are reclassified as people-generated and tracked accordingly
- All updates sync automatically back to Salesforce — no manual export required
Troubleshooting
| Problem | Likely Cause | Solution |
|---|---|---|
| Sparkle icon not visible on columns | Autodoc may not be enabled for this object | Contact your admin to confirm Autodoc is active for the object |
| Bulk selector is grayed out | Insufficient edit permissions | Request Data Dictionary edit access from your workspace admin |
| Job appears to stall past 5 minutes | Large object with complex field types | Wait up to 10 minutes; refresh the page to check status |
| Existing descriptions were not overwritten | Expected behavior — human-authored content is protected | Autodoc never overwrites manually entered content; edit the field directly if changes are needed |
| Sparkle icon remains after editing | Edit was not saved | Click into the field, make any change, and confirm — the icon clears on save |
Comments
0 commentsPlease sign in to leave a comment.