On-Demand Documentation
On-Demand Documentation writes a targeted document about your Salesforce org from a request in plain language -- "Document the full lifecycle of an Opportunity, from creation to close", "Explain lead routing across all automations". The document is written from the facts of a published documentation version, with its sources, and appears in your list of requests, ready to read or export.
It does not run a new scan: it works from the scan data you already have.
Where to find it
In the aprity web portal, open On-demand documentation in the AI assistants group of the menu.
How it works
- Describe what you need in the text box (up to 500 characters). Be specific: "Explain the business rules and dependencies of the Account object" works better than "Document Account".
- Pick the output language -- English, French, Spanish, German, Italian or Portuguese.
- Pick the version -- the latest documentation version is selected by default.
- Pick one or more formats (see below). HTML is selected by default.
- Click Generate documentation. The request moves through three steps -- searching sources, writing the document, formatting -- and typically completes in a few dozen seconds. The list refreshes on its own.
- Read or export the result from the Recent requests list.
Output formats
| Format | How you get it |
|---|---|
| HTML | Opens in the portal (Read). |
| Word (.docx) | Download. |
Additional formats (PDF, Excel, CSV, PowerPoint, Markdown, JSON, PNG, JPEG, SVG, Mermaid) are offered only when they are enabled for your aprity deployment. Formats that are not available are not shown.
Generated files are private: they are served through your signed-in portal session only.
Managing requests
The Recent requests list groups your requests by date and shows their status (Queued, Generating…, Completed, Failed). For each request you can:
- Read the HTML result or download the other formats you selected.
- Retry a failed request. A failed generation is not deducted from your quota.
- Delete a request you no longer need.
Plan availability
On-Demand Documentation is included on the Intelligence and Trial plans. It is not available on Documentation.
| Plan | Request budget |
|---|---|
| Documentation | Not included |
| Intelligence | 30 per month |
| Trial | 3 for the whole trial |
On Intelligence, the budget resets on the first day of each calendar month. When it is used up, you can still read and export the documents you already generated. See Plan Comparison for the full feature matrix.
On-demand documents vs. the full documentation
| Aspect | Full documentation (scan) | On-demand document |
|---|---|---|
| Scope | The whole org, within the scan scope | One specific question |
| Source | A new scan of your org | An existing documentation version |
| Output | The complete documentation in the portal | One focused document |
| Budget | Scan frequency of your plan | Request budget of your plan |
Use the full documentation to browse and search your org. Use on-demand documents when a stakeholder needs a focused write-up on one topic: an onboarding guide, a process explanation, a scoping summary.