v.0.6.0 Release

This release took a bit longer to be published as it contains some bigger updates that required more review and testing. Here's what's in it:

• The generated graphs now use a better top to bottom layout. Previously, while the layout was mostly working topdown, sometimes nodes/containers were added to the right of others, even resulting in some "zig-zag" flows. Now, the generated graphs avoid this and show the proper flow of the Flow from the top down to the bottom without jumping left and right
• The number of connections and the number of actions are now shown in the generated documentation
• Previously, variables were shown in a simple list. Now, more details are shown per variable, including where in the Flow they are used! If you have a large Flow and want to see where a specific variable gets used, this is where you can find a list of those actions
• Tables are now using full document width! Previously, they used whichever width was required for their content.
• Actions now include a section on any conditions for the subsequent action(s). For example, you may configure a specific action only to run if the previous action Failed. This is now shown in the documentation for the previous action
• Some general improvements for the generated Word documentation to enhance compatibility with Word Online. Sometimes documents couldn't get opened or edited online, sometimes the Tables didn't show properly (see e.g. #22). This should now hopefully be a thing of the past, as the generated document is now more stable

You can see a small presentation with visual details of the improvements and updates on my LinkedIn post: https://www.linkedin.com/posts/modery_improvements-flowdocumenter-v060-activity-6872360030369394688-Mxzf

v.0.5.0 Release

Bigger gap between releases this time as I was busy with other things in my life, but finally completed testing and verifying the latest release which contains the following:

• Use an existing Word document (.docx) to use as the template for the generated documentation
• Updated the GUI slightly to use icon buttons (and also make it possible to select the Word template)
• Implementation of a simple notification system as part of the processing: basically, the console application and the GUI are now able to show in more detailed what's happening during the processing
• Added the timestamp of when the documentation was generated to the Flow Metadata section

As usual, for any comments and feedback, please log an issue or discussion item

v.0.4.1 Release

This release mainly fixes some bugs with only some minor improvements, including

• properly parsing connection references (e.g. #19 )
• showing Trigger details in the table format (#15)

v.0.4.0 Release

A smaller update that contains the following improvements:

• Actions are now listed in alphabetical order
• added a new section that lists all Variables towards the beginning of the documentation
• Flows with a lot of depth (deeply nested actions) couldn't be parsed. Increased the MaxDepth from 64 to 128, which should be sufficient (see #17)
• Fixed a case where edges between nodes/clusters were missing (see #16 )

Full Changelog: v-0.3.0...v-0.4.0

v.0.3.0 Release

This release contains a range of valuable improvements and additions.

Windows application PowerDocu.GUI added to start Flow processing

Previously, the console application had to be used to generate documentation for a Flow. In this release, we now make PowerDocu.GUI available, a Windows application that helps to generated documentation without having to use the console application.

Processing exported Solutions

Previous versions only allowed to parse a single exported Flow. However, very often Flows are contained in Solutions, and there may even be multiple Flows in a Solution. It is now possible to use either a Flow package or a Solution package as input. For a Solution package, all of the Flows contained inside will be processed and documented, each with its own set of documentation.
Visit the Examples page to see a documented Solution

Improved Graphs

The graphs in previous versions were often not very clear when it comes to order of execution, as the arrows pointing from one component to another were not always correct. With this release, this issue has been fixed. More information is listed in (#5)

Less raw JSON output, more tables!

Parsing has been improved, and details of the Flow (especially actions) are now shown in table format instead of simple JSON output.

New Contributors

• @cakriwut made their first contribution in #13

Full Changelog: v-0.2.0-alpha...v-0.3.0

For any issues or suggestions, please provide your feedback as an Issue or Discussion

v.0.2.0-alpha Release

This updated release brings with it a few improvements:

• Better output of "Expression" nodes, which are e.g. used in Condition actions (If). Instead of the expression code, we are trying to display the expression in a table format.
• Handling of special characters in filenames - some characters (e.g. diacrits such as German Umlauts, Chinese, emoji, ...) don't work properly with file and folder names. They now get replaced with a dash (-)
• the output folder and the generated files are now created in the same folder as the Flow package (zip file) instead of the program directory
• you can now call the program from other locations as well (e.g. from a different folder). Previously, this didn't work as the related resources were loaded from a relative path from where the program was executed from
• Actions now contain links to "subactions and elseactions" (that is, any action that is to be considered "inside" the current action, such as the actions executed within a Condition (if) action) within the Word document

However, it is still considered to be an early version, and it is expected that it will not always run successfully. For any issues or suggestions, please provide your feedback as an Issue or Discussion

Full Changelog: v-0.1.0-alpha...v-0.2.0-alpha

Initial alpha release v.0.1.0-alpha

This is it! The first version of FlowDocumenter is now available!

• Please refer to Installation & Usage on how to use the tool. Also, please review the tech requirements and choose either the regular version or the self-contained version
• Please provide feedback and report any issues that you can encounter! This way the tool can be enhanced and improved over time
• Most importantly, please keep in mind that this is an early version. It has been tested with a limited set of Flows, and it is far from being feature complete.

Looking forward to hearing your feedback!