Documentation of Model / Version Documentation

Is there a way in Alteryx to export a view of what the workflow to show what model is doing – like each tool, formula, join, summarize, annotations, images, etc. in word format for someone who has never used Alteryx and is unfamiliar to see what our model is ultimately doing?Ultimately need documentation of the model logic automated.

I am really interested and intrigued to see how I can export something to show leadership (who are unfamiliar with Alteryx) the model logic. Thanks in advance.

Workflow

Developer Tools

Output

Best Practices

Optimization

Documentation

Accepted answers

All comments

Qiu

@eisesara
It would be good if something like that becomes available.

AngelosPachis

Hi @eisesara ,

Documentation is not automated in Alteryx yet, apart from the annotation appearing under each tool.

However, you can document your workflows through using a comment box, which allows you to add text and colour. Via the comment box tool, you can add a title to your workflow, when that was last edited/version of the workflow and explain briefly what each part of the workflow does by grouping certain tools inside the comment box.

As I said, this is not automated and you have to put the effort in to return dividends, but it will serve the purpose if you want to show to people that are not very experienced with Alteryx.

Hope that helps,

Angelos

jalizmaldonado

Good morning, I hope all is well.

After completing my workflow, I added comments to each tool explaining the step of the process within Alteryx. Then I took a screenshot and added it to my processes and procedures. From there, I downloaded the icons, C:\Program Files\Alteryx\bin\RuntimeData\HtmlAssets\help.alteryx.com\AlteryxCurrent\en to further explain what data was manipulated at which step so that the target audience was both able to see the big picture and dive into the weeds of the process. Hope this helps.

LindsayG

Hello @eisesara,

You could look into Workflow Admin Manager (WAM). This application streamlines the documentation and management of Alteryx workflows, it allows for audit reporting, mass updating across workflows, as well as tracking workflow changes. The reports provide insight into data sources, tools used, configurations, version control, and workflow visualization, these can then be shared easily.

If you are interested in more information, go to this link:

https://gallery.alteryx.com/#!app/Workflow-Admin-Manager-for-Alteryx-by-Capitalize-Analytics/5fb3ff280462d71998ca9146

eisesara

Thank you @LindsayG

I just submitted our workflow on Capitalize website. Looking forward to the results. I will let you know if this worked for us. Thank you!!

Quick Links

This months top contributors

atcodedog05 19458

Qiu 15866

binu_acs 15708

MarqueeCrew 13708

apathetichell 13703