UiPath Documentation
marketplace
latest
false
Marketplace user guide

User guide template for ready-to-go automations

Template structure and guidance for documenting ready-to-go automations on UiPath Marketplace.

Introduction​

  • In this section, briefly describe your Ready-to-go automation and what is the purpose that it serves.
  • Describe what functionality the Ready-to-go automation provides.
  • Specify the compatibility with UiPath Assistant.
  • Add any relevant videos, demos, and screenshots that showcase the automation's capabilities.

Use Cases​

  • In this section, explain how the automation will be used in a business process and its benefits. What problem does it solve?

System Requirements​

  • Provide here the essential system requirements to execute the Ready-to-go automation. Few recommendations for system requirements are provided for example below:

    HardwareMinimumRecommended
    CPU2 x 1.8GHz 32-bit (x86)4 x 2.4GHz 64-bit (x64)
    RAM4 GB8 GB

Prerequisites​

  • Provide here any software pre-requisites or configuration to be done before executing the Ready-to-automation. Few software specifications are provided for example below:

    SoftwareSpecifications
    Operating SystemWindows 10
    UiPath AssistantDesktop app for automation
    Microsoft ExcelMicrosoft Excel for Microsoft 365 MSO

Security measures​

  • Mention here any security measures to be considered.

Setup and configuration​

  • Provide here details of any configuration to be done before running the Ready-to-go automation (Optional).
  • Provide here the steps to install the NuGet from UiPath Marketplace and run it in Assistant.

Reports​

  • Use this section to provide information about any reports generated in the execution.
  • Use this section to provide information about any logs generated in the execution for the purpose of troubleshooting or auditing.

Support​

  • Provide here any email or link to reach out for support.

Was this page helpful?

Connect

Need help? Support(opens in new window)

Want to learn? UiPath Academy(opens in new window)

Have questions? UiPath Forum(opens in new window)

Stay updated