Skip to main content

How to Use On-Demand Documentation

On-Demand Docs lets you ask specific questions about your Salesforce org and receive focused documentation in response, without running a full scan.

Prerequisites​

  • Active aprity subscription with On-Demand quota remaining.
  • At least one completed scan (On-Demand Docs uses scan data as context).

Steps​

  1. Open the aprity app in Salesforce.
  2. Navigate to the On-Demand Docs tab (marked with a BETA badge in the sidebar).
  3. Type your question in the text field (maximum 500 characters).
  4. Select the desired output format: HTML, DOCX, PDF, or Confluence. Some formats may be locked depending on your plan and enabled features.
  5. Select the language for the generated documentation (six languages available: English, French, Spanish, German, Italian, Portuguese).
  6. Click Generate Documentation.
  7. The request enters a processing queue. A progress indicator with a pulsing dot shows the current status.
  8. When processing completes, click the download button to retrieve the generated document.
info

On-Demand Docs queries are subject to a monthly quota that varies by plan. Your remaining quota is displayed at the top of the tab as "X of Y queries used this month."

Example Questions​

  • "How does the lead conversion process work?"
  • "What automations fire when an Opportunity is closed?"
  • "Explain the validation rules on the Account object."
  • "What are the dependencies between Case triggers?"

Tips for Better Results​

  • Be specific in your questions. Narrow queries produce more detailed documentation.
  • Reference specific object or rule names when possible.
  • Keep questions focused on a single topic for the best output quality.
tip

On-Demand Docs works best when you have a recent completed scan. The fresher your scan data, the more accurate the generated documentation.