283ee09c-1a01-41c8-ad64-daa29ccf7859.jpg

Senior Integration Developer | UiPath MVP 2022, 2023

0e706bf9-c839-460c-ba5e-b1023f3aebf9.zip

**Problem Statement:** It is difficult to get an overview of projects after the development phase. Solution designers and reviewers can benefit from a script, which can easily provide an overview of the workflows developed in the project.

**Solution:** This script iterates through the project folder. For each workflow found, it extracts important design details, such as name of the workflow, variables, arguments and imports used. The output HTML is saved in a human readable format.

  

**Usage 1 - Using the sample project provided:**

1.  Clone the GitHub repository / Download the .ps1 file.
2.  Navigate to the cloned repository.
3.  Run the DocumentationUiPathSampleProject.ps1 file in PowerShell.
4.  The output HTML file will be saved in the cloned repository location.

**Usage 2 - Using one of your projects:**

1.  Clone the GitHub repository / Download the .ps1 file.
2.  Navigate to the cloned repository.
3.  Open the DocumentationUiPathSampleProject.ps1 file in any preferred IDE.
4.  Comment out the line which calls the function DownloadSampleFromUiPathForum.
5.  Edit or Replace the $ProjectPath variable with the location of your project.
6.  Run the DocumentationUiPathSampleProject.ps1 file in PowerShell.
7.  The output HTML file will be saved in the cloned repository location.

The output of the script for a sample project can be viewed in this GitHub [link](https://jeev20.github.io/UiPathProjectDocumentation/).

A script which automates the process of documenting a UiPath project and presents the output in a HTML file.

a1f520ab-70e9-4983-b111-959c79e897aa.png

MIT License Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the 'Software'), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Project Documentation using PowerShell