Go to appAcademyWhat's new?

                                                                                      Documenting workflows

                                                                                      Documenting workflows solves the challenge of understanding workflows without manually reviewing every detail. This feature uses AI to automatically generate workflow descriptions, providing instant insights and saving time.

                                                                                      Key benefits:

                                                                                      • Saves time: Eliminates the need to manually review every workflow detail.

                                                                                      • Boosts collaboration: Enables quick understanding and adoption of workflows by team members.

                                                                                      • Facilitates onboarding: Helps new users grasp workflow functionalities faster.

                                                                                      • Supports scalability: Simplifies documentation across multiple teams.

                                                                                      You can annotate your workflow, add TODOs, instructions, links or images by filling out the Workflow description field. You can find the description field:

                                                                                      • In the builder, in the left-hand side Workflow info panel, when you click Edit.

                                                                                      • In the builder, under “Workflow settings” 

                                                                                      • In the workflow creation modal

                                                                                      • In the workflows list, when you choose Quick edit for a chosen workflow.

                                                                                      The description is then exposed in the Workflow info panel inside the builder (left hand side menu).

                                                                                      For special formatting, lists, images and links you can use markdown.

                                                                                      Please see our guide on how to use markdown for a full list of available markdown features.

                                                                                      Example:

                                                                                      This is the source markdown that results in the description above:

                                                                                      1
                                                                                      This workflow captures leads from a CSV file and uses these to create contacts in HubSpot as per [this JIRA ticket](https://tray.io)
                                                                                      2
                                                                                      [![Image alt text]  (https://images.ctfassets.net/p3dvvupz8xw4/2qMBaEVZfovsTFHzuZtYhc/d316700f915c3c25c99539a3e4d7fae2/csv-hb-result.png)](https://tray.io/)
                                                                                      3
                                                                                      On every update an email gets sent to the Marketing team *marketing@ourcompany.com*
                                                                                      4
                                                                                      Here is the feature flag key used for this functionality:
                                                                                      5
                                                                                      `Example-feature-flag-230413`
                                                                                      6
                                                                                      ---
                                                                                      7
                                                                                      **TODO:** 
                                                                                      8
                                                                                      - ~~Add Slack message confirmation~~ (done by Chris, 17 Apr)
                                                                                      9
                                                                                      - Attach the CSV to the email
                                                                                      10

                                                                                      AI workflow description
                                                                                      Copy

                                                                                      This feature is available only to users who have Merlin enabled.

                                                                                      To access the AI workflow description, click on the lightbulb icon on the left sidebar.

                                                                                      This will open the Workflow info panel.

                                                                                      The AI workflow description feature automatically generates a summary of your workflow. This summary is based on the workflow's steps and logic, providing a concise description of what the workflow accomplishes.

                                                                                      After the AI generates a summary, there are several controls available to manage this summary. These controls allow you to interact with the AI-generated content as follows:

                                                                                      1. Regenerate: Regenerate the AI summary if the current one is not satisfactory or out of date.

                                                                                      2. Copy: Copy the AI summary to use it elsewhere.

                                                                                      3. Bad summary: Indicate that the AI summary is not accurate or helpful - this will help Tray to improve the auto AI workflow description accuracy in the future.

                                                                                      Out-of-date highlighting
                                                                                      Copy

                                                                                      The system flags descriptions that might be outdated, prompting users to regenerate them to maintain accuracy.