For the complete documentation index, see llms.txt. This page is also available as Markdown.

Documentation Agent

The Documentation Agent writes and maintains the documentation for your integrations.

Point it at a flow and it generates a clear, structured description - endpoints, mappings, and change history - written for your team rather than left as tribal knowledge.

Rather than keeping a separate document in sync by hand, you get living documentation that reflects what the flow actually does, generated on demand and downloadable when you need to share it.

What it produces

When you ask it to document a flow, the Documentation Agent reads the flow configuration and produces a single, structured write-up covering:

  • Overview - what the flow does and how it is intended to run.

  • Trigger - how execution starts, including schedule or event detail.

  • Data flow - how the payload moves from step to step, start to finish.

  • Shapes - each step in sequence, with its purpose, key configuration, and notes.

The documentation reflects the current state of the flow at the time it is generated, so it stays aligned with the configuration rather than drifting out of date.

How to use it

There are three ways to interact with the Documentation Agent, depending on where you are working.

From the Platform Agents page

Navigate to AI Studio → Platform Agents and select the Documentation Agent card, then click Start conversation. Ask it to document a flow by name and it locates the flow, generates the documentation, and gives you a link to view it.

From the flow directly

Open any Process Flow and select Flow documentation from the flow toolbar. The agent generates documentation for the flow in place, showing the overview, trigger, data flow, and per-step breakdown in a side panel. Use Regenerate to refresh it after changes, or Download PDF to export a copy to share.

From a shape's Notes

From a shape's Notes. Open the Notes panel on any step and choose Generate note with AI. The agent documents what that individual step does - its configuration and effect on the payload - and drops the text straight into the note, ready to edit, colour-code, and save.

Last updated

Was this helpful?