> For the complete documentation index, see [llms.txt](https://doc.wearepatchworks.com/product-documentation/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://doc.wearepatchworks.com/product-documentation/ai/patchworks-ai-studio/platform-agents/documentation-agent.md).

# Documentation Agent

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

{% hint style="success" %}
The Documentation Agent is **active** on your account. Access it from the AI Studio, from within any Process Flow, or from a step's Notes panel.
{% endhint %}

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.

<figure><img src="https://2440044887-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FLYNcUBVQwSkOMG6KjZfz%2Fuploads%2FEGNOxGjpHbC84WHnjcmL%2Fdocumentation-agent-card.png?alt=media&amp;token=de507968-9519-4603-93bd-ed332d93e235" alt=""><figcaption></figcaption></figure>

### What it produces <a href="#sources" id="sources"></a>

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 <a href="#sources" id="sources"></a>

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

<details>

<summary><strong>From the Platform Agents page</strong></summary>

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.&#x20;

<figure><img src="https://2440044887-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FLYNcUBVQwSkOMG6KjZfz%2Fuploads%2FCX6dRgevEdx0sNIJ13Le%2FScreenshot%202026-08-25%20at%2015.22.56.png?alt=media&amp;token=293b6f2c-e23d-4fa9-8320-8517d6b915b7" alt=""><figcaption></figcaption></figure>

</details>

<details>

<summary><strong>From the flow directly</strong></summary>

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.&#x20;

<figure><img src="https://2440044887-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FLYNcUBVQwSkOMG6KjZfz%2Fuploads%2FADK0Ht0TzTRgWXnhH1ES%2Fimage.png?alt=media&amp;token=aa0bbc0a-0a87-44ef-ac41-0be268253a7d" alt=""><figcaption></figcaption></figure>

<figure><img src="https://2440044887-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FLYNcUBVQwSkOMG6KjZfz%2Fuploads%2FBJva1a3OzNTGevaxKcrN%2Fimage.png?alt=media&amp;token=1a7c9f0c-ee41-4bb2-8fcb-f76700a3a642" alt=""><figcaption></figcaption></figure>

</details>

<details>

<summary><strong>From a shape's Notes</strong></summary>

**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. &#x20;

<figure><img src="https://2440044887-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FLYNcUBVQwSkOMG6KjZfz%2Fuploads%2Fy0hgpCCrHTsU3YfWEiI5%2FScreenshot%202026-08-25%20at%2014.55.08.png?alt=media&amp;token=e71fbdeb-0225-4b78-992a-703f32429e15" alt=""><figcaption></figcaption></figure>

<figure><img src="https://2440044887-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FLYNcUBVQwSkOMG6KjZfz%2Fuploads%2Fbr8nIuRgwAz7xvVSAYJQ%2FScreenshot%202026-08-25%20at%2014.55.27.png?alt=media&amp;token=05182bc3-5324-4846-8025-18634062d0a2" alt=""><figcaption></figcaption></figure>

</details>
