On-Demand Documentation
On-Demand Documentation lets you generate targeted documentation for specific questions about your Salesforce org. Instead of running a full scan, describe what you need in plain language and aprity produces a focused document.
How It Works
- Enter a query -- type a natural language question or request (up to 500 characters).
- Select a format -- choose from the available output formats.
- Generate -- aprity analyzes the relevant metadata and produces a focused document addressing your query.
The result is a document scoped to your specific question, generated without running a full org-wide scan.
Query Interface
The On-Demand Documentation interface is available in the aprity app under the On-Demand tab.
Writing Queries
Write your query in natural language. Be specific about what you want documented. Examples:
- "Document all validation rules on the Opportunity object."
- "Explain the automation that runs when a Case is created."
- "List all fields on the Account object and their business purpose."
- "What flows fire when a Lead is converted?"
More specific queries produce better results. Instead of "document Account," try "explain the business rules and dependencies for the Account object."
Character Limit
Queries are limited to 500 characters. This is sufficient for detailed questions but encourages focused requests. If you need comprehensive org-wide documentation, use a standard scan instead.
Output Formats
On-Demand Documentation supports the following output formats:
| Format | Available |
|---|---|
| HTML | Yes |
| DOCX | Yes (Professional and Enterprise) |
| Yes (Professional and Enterprise) | |
| Confluence | Yes (Enterprise, requires connector) |
Markdown and Knowledge formats are not available for On-Demand Documentation. Use a standard scan for these formats.
Monthly Quota
On-Demand Documentation is subject to a monthly usage quota that varies by plan:
| Plan | Monthly Queries |
|---|---|
| Trial | 3 |
| Starter | -- |
| Professional | 10 |
| Enterprise | 50 |
The Starter plan does not include On-Demand Documentation. Upgrade to Professional or Enterprise for access.
The quota resets on the first day of each calendar month. Unused queries do not roll over to the next month.
Quota Tracking
The On-Demand tab displays your remaining queries for the current month. When the quota is exhausted:
- The query input is disabled.
- A message indicates when the quota resets.
- A prompt to upgrade is shown if a higher plan would increase your quota.
Query History
The On-Demand tab maintains a history of your previous queries. Each entry shows:
- Query text -- the original question you asked.
- Date -- when the query was submitted.
- Format -- the output format selected.
- Status -- whether the document was generated successfully.
Click a history entry to re-download the generated document or to review the original query.
Query history is retained for 90 days. After that, history entries are removed but any downloaded documents remain on your local machine.
Comparison with Standard Scans
| Feature | Standard Scan | On-Demand |
|---|---|---|
| Scope | Entire org | Specific question |
| Duration | 5-15 minutes | Under 2 minutes |
| Output | Full documentation set | Single focused document |
| Formats | All 6 | HTML, DOCX, PDF, Confluence |
| Quota | Unlimited (per plan) | Monthly quota |
Use standard scans for comprehensive documentation. Use On-Demand for quick, targeted questions.
When to Use On-Demand Documentation
- You need documentation for a specific object or automation quickly.
- A stakeholder has asked a pointed question about how something works in Salesforce.
- You want to verify the behavior of a single flow or trigger without running a full scan.
- You need a quick deliverable for a meeting or review without waiting for a full scan to complete.