Summary

PowerDocu automates the generation of technical documentation for Microsoft Power Automate Flows and Power Apps canvas apps, addressing the significant time investment typically required for manual documentation. It provides a user-friendly Windows GUI executable, enabling developers and technical teams to quickly produce comprehensive documentation for better understanding, knowledge sharing, and configuration management.

How It Works

The tool processes exported artifacts such as Power Automate Flow packages, Power Apps canvas app exports, or entire Solution packages. PowerDocu parses these inputs to systematically extract and present information. For Flows, it details general information, connectors, triggers, and actions, alongside generating visual diagrams. For Apps, it enumerates screens, controls, global variables, collections, data sources, and resources, providing a granular view of app structure and logic. The generated documentation aims to offer both a high-level overview and detailed technical specifications.

Quick Start & Requirements

Detailed installation and usage guidance is available in the "Installation & Usage" section of the project's documentation. The README also points to YouTube for an introductory overview and a live demo of the tool in action. PowerDocu is distributed as a Windows GUI executable, implying a Windows operating system requirement.

Highlighted Details

• Supports automatic documentation generation for Power Automate Flows, Power Apps canvas apps, and comprehensive Solution packages.
• Offers flexible output formats, including editable Word documents, standard HTML, and Markdown for integration with platforms like GitHub or Azure DevOps.
• Flow documentation includes detailed sections on general information, connectors, triggers, actions, and generates both high-level and detailed diagrams in PNG and SVG formats.
• Canvas app documentation provides an overview of screens, controls, global variables, collections, data sources, and resources, with a deep dive into individual control properties.
• Solution documentation extends to detailing all components within a solution, including apps, flows, and Dataverse tables, offering a holistic view of the solution's architecture.

Maintenance & Community

The project actively encourages community involvement. Contributions are welcomed through forking the repository and submitting Pull Requests for code improvements or new features. Users are directed to log bugs and issues via the GitHub Issues tracker, while suggestions and feature requests can be submitted through the project's Discussions forum.

Licensing & Compatibility

The specific license under which PowerDocu is distributed is not explicitly mentioned in the provided README text.

Limitations & Caveats

The provided README does not detail any specific limitations, known bugs, or alpha/beta status. The project encourages users to report any encountered issues to help improve the tool's stability and functionality.