How to document a workflow
- On this page
- How to document a workflow
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.
This is the source markdown that results in the description above:
1This 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/)3On every update an email gets sent to the Marketing team *email@example.com*4Here 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 email10