# Document with RoboRewsty

{% hint style="info" %}
RoboRewsty is your go-to tool for simplifying the creation of comprehensive documentation for your workflow tasks. It takes care of the process behind the scenes, freeing you to focus on building your workflow while ensuring that the documentation is handled seamlessly.
{% endhint %}

## How does RoboRewsty work?

RoboRewsty integrates with the workflow builder canvas. It takes your workflows' JSON objects, and sends them to a private OpenAI Azure instance. The result is a quickly presented, well structured documentation breakdown of all selected tasks in your workflow.&#x20;

{% hint style="warning" %}
RoboRewsty does not replace the existing note feature in the workflow builder. You can either add notes manually, or use RoboRewsty to help you do some of the heavy lifting.
{% endhint %}

## Use RoboRewsty

### Via workflow builder

1. Create a new note.&#x20;
2. Drag your note to encompass all actions in the workflow that you wish to document. This can be a subset of the workflow, or the entire workflow.
3. Click <img src="https://1835401289-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FAQQ1EHVcEsGKBPVHmiav%2Fuploads%2FWMMyLaddicPCrOVF2lYS%2FScreenshot%202025-03-05%20at%202.41.06%E2%80%AFPM.png?alt=media&#x26;token=e488d55d-8058-4bdc-94fd-a60b64c77df5" alt="" data-size="line"> in the top toolbar of the workflow builder.&#x20;
4. Hover over the **Notes** note name field to reveal the hidden options for notes.\
   \
   ![](https://1835401289-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FAQQ1EHVcEsGKBPVHmiav%2Fuploads%2F9zIbgxO1uPV5ZP5lV1zY%2FScreenshot%202025-03-06%20at%205.15.17%E2%80%AFPM.png?alt=media\&token=f50ccd4b-c623-448c-91ab-8e9f4caf3469)
5. Click <img src="https://1835401289-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FAQQ1EHVcEsGKBPVHmiav%2Fuploads%2F8b2UtILOJ3shC8ZXtPYW%2FScreenshot%202025-03-06%20at%205.18.18%E2%80%AFPM.png?alt=media&#x26;token=ac5831ca-c945-4370-8a71-2b0183cd8f8b" alt="" data-size="line">. This will launch RoboRewsty. A waiting message will display while it runs on your workflow. This may take a moment, if your request holds a large number of tasks.
6. View the notes generated in your **Notes** menu. Sections will include:
   1. **What's Occurring: Task Overview:** Each documentation response begins with a clear and concise overview, providing users with a high-level understanding of the task's purpose and context.
   2. **Expected Outcome: Task's Expected Result:** Information about the expected outcome or result of the task or group of tasks is presented. This section helps users anticipate the outcomes when the workflow executes the associated tasks.
   3. **Special Considerations: Any Crucial Factors:** Special considerations or crucial factors related to the tasks are included. These details ensure that users have all the necessary information to understand the workflow path successfully.
   4. An accordion list of all included tasks

<figure><img src="https://1835401289-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FAQQ1EHVcEsGKBPVHmiav%2Fuploads%2FAR9AKpjhBEq2h1QzofRT%2FScreenshot%202025-03-06%20at%205.21.51%E2%80%AFPM.png?alt=media&#x26;token=35aecc7e-b1ac-448c-9806-ccce9d2d1a2c" alt=""><figcaption><p>A completed RoboRewsty note</p></figcaption></figure>

### Via publish workflow

<figure><img src="https://1835401289-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FAQQ1EHVcEsGKBPVHmiav%2Fuploads%2FHq3Jj0lidK0VL8LCR7lq%2Fimage.png?alt=media&#x26;token=c1a5fcbc-c4c0-40f8-af69-f1ed7cd37185" alt=""><figcaption></figcaption></figure>

RoboRewsty is also available to help when you publish a workflow. Click on the RoboRewst icon to generate a detailed change log, then **Submit**.
