Objective
Understand how Sweep’s Documentation Agent generates, maintains, and lets you search living documentation for your Salesforce configuration and processes—ideal for onboarding, alignment, and keeping changes well-documented.
Note: Each org has one Documentation Agent. It reads your org’s metadata and continuously reflects your current setup.
How to Use the Documentation Agent
Open the Agentic Layer
Top navigation → Agentic Layer.
Select the Documentation Agent
Click Documentation (Metadata) Agent → New chat (or open a recent conversation).
Click Agent settings on the left-hand sidebar. You’ll see three configuration tabs:
Instructions – Define how your agent should think, speak, and prioritize context.
In the Instructions tab, you can add custom directives that help the agent understand tone, intent, and goals.
This section tells the Documentation Agent how to handle specific types of user questions or metadata scenarios.
Examples of useful Documentation Agent instructions:
“Use a helpful, explanatory tone suitable for onboarding a new Salesforce admin.”
“Summarize automation logic using bullet points and link to relevant metadata.”
“If a user asks about dependencies, include both direct and indirect relationships.”
“Generate outputs that can be shared directly with RevOps or Customer Success teams.”
“When describing flows, note key triggers, entry criteria, and affected fields.”
Files – Upload reference materials or best-practice guides to shape responses.
If your team maintains internal process docs, best practices, or naming conventions, upload them here under Files.
This helps the Documentation Agent generate responses that align with your internal standards.
Examples of what to upload:
“Salesforce Naming Conventions” PDF
“Lead Scoring Model Overview” doc
“MEDDICC Implementation Guide”
These materials become additional reference context when the agent answers questions.
Tuning – Adjust how detailed or concise the responses should be.
Explore or guide your documentation
Once everything’s set up, your Documentation Agent is ready to assist. You can explore documentation generated from your org’s metadata or ask the agent to:
Explain how a particular object, field, flow, or validation rule works
Summarize the structure of complex automations
Track dependencies across your configuration
Document business logic tied to specific record types or processes