Objective
Understand how to view, search, and use Sweep’s automatic documentation features.
Documentation Overview
Sweep Documentation automatically creates a live, searchable record of your Salesforce metadata. It replaces manual documentation with always up-to-date insights, showing how every object, field, automation, and dependency connects within your org.
Every metadata element in your Salesforce environment (like Flows, Apex Classes, Validation Rules, CPQ Configurations, and Custom Fields) is indexed and documented with:
AI-generated explanations describing purpose and behavior
Change tracking for created and modified details
Dependencies and references so you can see what affects what
Direct access to deeper analysis and related processes
How to Use Documentation
Access Documentation
From Sweep’s top navigation, go to Impact Analysis → Documentation.
You’ll see a structured, filterable table containing all your Salesforce metadata.
Browse and Filter
Use the right-hand panel to filter by category — such as Automation, Code, Custom Metadata, or CPQ.
You can also search for a specific metadata element (e.g., “Opportunity Stage Flow” or “Lead Score Field”).
Open a Metadata Card
Click any metadata item to open its detailed view.
Each Metadata Card includes:
Description: AI-generated explanation of its purpose and logic.
Details: Created/modified by, timestamps, and attributes.
Dependencies: Relationships with other fields or automations.
Used By / References: Downstream elements that rely on this metadata.
AI Chat Agent: Ask natural language questions like:
“Where is this field used?”
“Which automations update the Opportunity stage?”
Use Cases
Automated Org Documentation: Maintain an always-current record of all metadata, including Flows, Fields, Apex, and Validation Rules.
Audit Readiness: Produce real-time documentation for compliance and security reviews (e.g., SOX, GDPR, HIPAA).
Change Management: Identify dependencies before modifying a field or flow, ensuring safe, predictable updates.
Impact Analysis: Trace downstream effects of changes, such as which automations or formulas reference a field you’re editing.
Troubleshooting: Quickly locate and understand the source of Salesforce errors or automation conflicts.
Cross-Team Collaboration: Give RevOps, IT, and business users a common language for understanding Salesforce structure.