Project Documentation using PowerShell
by Jeevith Hegde
0
13
Project Documentation using PowerShell
by Jeevith Hegde
0
Solution
13
Summary
Summary
Overview
Overview
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:
- Clone the GitHub repository / Download the .ps1 file.
- Navigate to the cloned repository.
- Run the DocumentationUiPathSampleProject.ps1 file in PowerShell.
- The output HTML file will be saved in the cloned repository location.
Usage 2 - Using one of your projects:
- Clone the GitHub repository / Download the .ps1 file.
- Navigate to the cloned repository.
- Open the DocumentationUiPathSampleProject.ps1 file in any preferred IDE.
- Comment out the line which calls the function DownloadSampleFromUiPathForum.
- Edit or Replace the $ProjectPath variable with the location of your project.
- Run the DocumentationUiPathSampleProject.ps1 file in PowerShell.
- The output HTML file will be saved in the cloned repository location.
Features
Features
- Read the workflow files in the project recursively and provide filtering options to limit certain files or folders.
- Get name of the workflow and the annotation of the workflow.
- Get workflow variable details --> variable names, variable scope, variable annotations and variable types.
- Get workflow argument details --> argument names, argument annotations and argument direction and types.
- Get imports and/or assembly references used in the workflow.
- Save the output to an HTML file.
Additional Information
Additional Information
Dependencies
Code Language
Visual Basic
License & Privacy
MIT
Privacy Terms
Technical
Version
1.0Updated
17 May 2022Certification
Silver Certified
Tags
Automate
Application
Microsoft PowerShell
Support
UiPath Community Support
Resources
Similar Listings
English
English
日本語