Advent of Code is back! Unwrap daily challenges to sharpen your Alteryx skills and earn badges along the way! Learn more now.
Free Trial

Alteryx Designer Desktop Discussions

Find answers, ask questions, and share expertise about Alteryx Designer Desktop and Intelligence Suite.

Documentation for workflow

tsumadeep
6 - Meteoroid

How to write a documentation for complex workflow,

2 REPLIES 2
ArnaldoSandoval
12 - Quasar

Hi @tsumadeep 

 

Documenting complex workflows once they are written is challenging, there are documentation tip better done while developing the workflow, these are some community videos, topics, etc.

 

Catch the ACEs at Happy Hour and this is what you might hear... 

Documentation Best Practices with Alteryx 

Workflow Documentation Best Practices 

Alteryx 24 best practices 

 

and probably more, just Google for them.

 

Now, Alteryx just released the "Workflow Summary Tool" using AI, which is promising.

 

Introducing the Workflow Summary Tool, OpenAI 

How to Use the Workflow Summary Tool 

Workflow Summary Tool - Install 

 

WF-Summary-01.png

I also attached my Alteryx Workflow Template which may be useful.

 

hth

Arnaldo

 

esoden
8 - Asteroid

Workflow Admin Manager has a very robust documentation engine for Alteryx workflows saved locally or on Server. Creates Word, PDF, or SVG documents of your workflows, including all metadata, annotations, configurations, a diagram of the workflow, recommendations to make your workflow better, etc.

 

We have a lot of information posted on the website; you can purchase WAM from Alteryx or Capitalize.

We recently spoke with KPMG at Inspire, and on the following webinar; documentation was a key topic. The webinar discusses and demos documentation at the 27:00 minute mark.

https://capitalizeconsulting.com/webinar/alteryx-users-streamline-your-external-audit-with-wam-with-...

 

Here's the main site for WAM with short videos of many areas of the platform: https://capitalizeconsulting.com/workflow-admin-manager/

Documentation is the second video as you scroll down.

 

You can actually submit a workflow (just the XML file zipped) and you'll get a copy of the documentation emailed back to you: https://capitalizeconsulting.com/workflow-admin-manager-wam-audit-report-tool/ Please don't submit anything sensitive. Most workflows aren't but we'd be happy to get an NDA in place if you want to discuss something confidential.

 

Here's a video of AiDIN + WAM for documentation:

https://www.linkedin.com/posts/eric-soden_documentation-is-every-developersdream-activity-7095003292...

 

Here are some screenshots of the WAM Audit Doc:

1 Full Diagram.png2 Zoomed Diagram.png3 Tool Category.png4 Recommendations.png5 DB IN and OUT.png6 Tool Config.png

Labels
Top Solution Authors