You can generate detailed documentation for any flow directly from the Etlworks UI.
How to access it
To generate documentation, first open the Flow Editor for the desired flow. This applies to both regular and nested flows.
There are two ways to open the documentation popup:
-
Top right link in the flow editor
-
Documentation icon at the bottom right
Both options open the same popup window.
Documentation Popup
The popup includes two tabs:
Description – Markdown-formatted structured documentation
-
-
Flow title, tags, parameters, variables
-
Table of contents with step-by-step links (for nested flows)
-
Step-by-step details with connections, transformations, mappings, and code blocks
-
Diagram – Visual HTML/SVG diagram
-
-
Highlights flow structure and nested steps
-
Displays loops, conditions, error handling, parallel execution, disabled/daemon flows
-
Includes transformations and tooltips
-
Additional Features
-
Print or save as PDF from either tab
-
Works for any flow (nested or regular)
-
Structure and formatting match what’s returned by the Flow Documentation API
💡 Want to automate this? See Flow Documentation API