MarketplaceStudioSolutionCode Documentation Helper for UiPath

Create your first automation in just a few minutes.Try Studio Web

Code Documentation Helper for UiPath

Code Documentation Helper for UiPath

by Ahmed Al-Moqbali

StarStarStarStarStarStarStarStarStarStar

0

Solution

Downloads

176

back button
back button
carouselImage0
next button
next button

Summary

Summary

Automated solution to help in UiPath code documentation.

Overview

Overview

Challenge: After development, the design and architecture of the solution need to be documented in solution design document (DSD). It is a difficult and time-consuming process to get workflow (xaml files) details like file name, description, variables, and arguments. This will be more difficult if the solution contains many files.

Solution: This solution will provide an Excel file that contains basic information form project.json file, folder structure and all workflow details: file name, type, annotation, variables name and type, and arguments name and type.

Use cases:

1. Documenting DSD: Solution Architects or developers need to create the solution design document. This solution will provide all the code files details that have to be added in DSD.

2. Reviewing the code: The output of this solution will help QC team have an overview about the workflows so they can check and provide their comments for each workflow.

How to use it:

1. Download the code and unzip it.

2. Execute it and provide the code folder path where project.json is placed.

3. Once the process finishes, check the files in DocumentationHelper folder (C:\Users\UserName\Documents\DocumentationHelper).

Features

Features

This solution is easy to use and works in any environment where the UiPath robot is installed.

Additional Information

Additional Information

Dependencies

UiPath.Excel.Activities: [2.9.5], UiPath.System.Activities: [20.10.4] UiPath.WebAPI.Activities: [1.6.0]

Code Language

Visual Basic

Publisher

Ahmed Al-Moqbali

Visit publisher's page

License & Privacy

License Agreement

Privacy Terms

Technical

Version

1.0.0

Updated

October 18, 2022

Works with

Studio: 19.1 - 22.10

Certification

Silver Certified

Application

UiPath Studio

Support

UiPath Community Support

Similar Listings