Skip to main content

Generating Descriptions

Documentation goes stale the moment configuration changes. These features write descriptions from what is actually configured, so the document reflects the application as it stands today rather than when someone last updated it.

Each one is reached from its own control in Studio rather than from the chat panel.

Application description

Generates a complete, business-friendly README for your application, written for someone who needs to understand what the application does, what it connects to, and what is needed to run it, without reading any configuration.

Where: Application > Documentation tab > Generate using AI

The document always contains the same sections in the same order, beginning with an overview paragraph covering what the application does, what data flows through it, which systems it connects, and how it is triggered, followed by its deployment profiles and the rest of its configuration.

Because it is generated from real configuration, installation steps come from what is actually set up rather than from general guidance.

Regenerate part of it

If one section is not right, you can regenerate that part rather than the whole document.

Document a different application

You can generate a description for an application other than the one you have open by naming it.

Manifest description

Generates a description of the application as a package, rather than of what it does day to day.

Where: Manifest icon in the top toolbar > Overview tab > Generate using AI

Which one to use

Application descriptionManifest description
WhereDocumentation tabManifest panel > Overview tab
Available in chatYesNo
DescribesWhat the application does day to dayWhat the application is as a package

Workflow description

Generates a description for an individual workflow from its configuration.

Where: The Generate with AI control on a description field

Workflow descriptions appear wherever the workflow is listed, so a generated one saves the reader opening the workflow to find out what it does.

Generate text into a description field

Description fields carry a Generate with AI control that writes the field's content for you.

  1. Select Generate with AI on the description field.
  2. Either select Auto-generate to generate from the surrounding configuration, or enter your own instruction in the Custom prompt field and send it.
  3. Review the generated text, then accept it, discard it, or regenerate.

Accepting replaces the field's content. Discarding leaves the field as it was.

How you know it worked

The generated description appears in the field or document for you to review before saving. Nothing is written until you accept it.

Next steps