Skip to main content

How to Generate On-Demand Documentation

On-demand documentation writes a targeted document — a lifecycle, an onboarding guide, a scoping note — from a question you ask. It is written from the facts of a published documentation version, without running a new analysis.

Prerequisites​

  • Intelligence or Trial plan. On Documentation, the page shows Not included in your plan.
  • At least one published documentation version.
  • Requests remaining in your quota: 30 per month on Intelligence (reset on the 1st of the month), 3 for the whole trial on Trial.

Steps​

  1. In the portal's left navigation, click On-demand documentation (group AI assistants).
  2. In the text box, describe the documentation you need (up to 500 characters). For example:
    • "Document the full lifecycle of an Opportunity, from creation to close"
    • "Explain lead routing across all automations"
    • "Produce an onboarding guide for Case management"
  3. Choose the Language of the document.
  4. Choose one or more Formats. HTML is selected by default; the other formats offered (such as Word) depend on what your deployment makes available.
  5. Keep Latest version or pick another documentation Version to write from.
  6. Click Generate documentation.

The request appears under Recent requests and goes through three steps: searching sources, writing the document, formatting. It usually takes a few dozen seconds.

Use the result​

On a completed request:

  • Read opens the HTML document in the portal;
  • a download link appears for each other format you selected (for example Word);
  • Delete removes the request from the list.

If a request fails, click Retry. A failed request is not deducted from your quota.

When the quota is used up, documents already generated stay available to read and export.

Tips for better results​

  • Ask about one topic at a time, and name the objects or processes concerned.
  • Say what the document is for (onboarding, scoping, audit…): the structure follows.
  • Documents are only as recent as the version they are written from. After a significant change in your org, run a new analysis first.