This site uses different types of cookies, including analytics and functional cookies (its own and from other sites). To change your cookie settings or find out more, click here. If you continue browsing our website, you accept these cookies.
Alteryx will automatically build annotations on some tools (such as the filter tool) but not all.
To me docuemtantio should always be done by the owner and developer of the workflow. This human element to documentation will make it much more transferable than if a computer were to generate this information. You know your objective, and the objectives of a group of tools; the computer does not.
It is possible to analyse the a workflow using another workflow which could generate a document with key information in; but this would be a lengthy process.
An Alteryx workflow is an xml file; so therefore can be inputted and parsed using Alteryx.
There is one resource that will help you get started if this is something you want to look at, in the sample workflows > scripting and automation > batch macros > count number of tools.
As mentioned this is possible but I would never recommend this automatic documentation method; the workflow image and by clicking the tools acts as self documentation; it really need a a human who understands the projects to highlight the key steps.
I will share some images of our documentation process at a later date.
I would be interested to see some of your documentation suggestions. We're just starting our Alteryx journey. Scripts from our previous tool were not documented very well, if at all. We're trying to do things "right" this time around. Our documentation will be human-generated, the old fashioned way.
We also actively monitor that users are correctly filling in the meta info tab of their workflows using the MongoDB behind our Alteryx Server. This includes ensuring their is a link to an external word document which outlines key details behind the workflow including the input schema, output schema, what the purpose is and so on.