After you have built a Flow in Power Automate, you may consider documenting it as to allow others to get a better understanding of how it works, to ensure that any specific configuration in it is kept somewhere else as well, or for other reasons. However, manually documenting the technical implementation can be quite time consuming.
This is where FlowDocumenter can help!
Currently, this repository contains a solution to document Power Automate Flows, called FlowDocumenter. FlowDocumenter allows the automatic generation of technical documentation based on a provided exported Flow package.
The documentation includes
- A generated Word document including sections on
- General information of the Flow
- The connectors that are used by the Flow
- The Trigger that starts the Flow
- The actions used in the Flow
- A high-level and a detailed diagram of the Flow
- PNG and SVG renditions of the high-level and details diagrams
NOTE: FlowDocumenter is currently in a very early development stage! It offers basic functionality, but has a lot of room for improvement. If you find any bugs or other issues, please log an Issue in this GitHub project. For any improvement recommendations and suggestions, please open a Discussion. Most importantly, if you want to contribute to this project's code, please fork this repository and submit appropriate Pull Requests. Any kind of contribution is more than welcome!
Please refer to Installation & Usage for information on how to install FlowDocumenter and how to use it to generate documentation.
Please have a look at the examples provided.
FlowDocumenter is in a very early development stage at the moment. If you think of ways to improve it, here are some things that you can do:
- If it is not working properly or if you find a bug, please log a detailed Issue
- If you have a suggestion on what could be added or what could be done better, please add it under Discussions. Also, please have a look at the existing discussions and add any comments you may have
- Found some ugly code that should be improved? Got an idea for some additional functionality and want to implement it yourself? Please create a fork of this repo, make your changes, and submit a Pull Request!
- PowerApps-docstring is a console based, pipeline ready application that automatically generates user and technical documentation for PowerApps: https://github.com/sebastian-muthwill/powerapps-docstring
- FlowToVisio, a tool to create Visio representations of your Cloud Flows: https://github.com/LinkeD365/FlowToVisio