Skip to main content


Documenting a component

Suggest edit Updated on November 15, 2021

Document the components that you create to help users decide whether they can reuse your component in other applications.

  1. In the header of Dev Studio, click ConfigureApplicationComponents.
  2. Select the component that you want to document.
  3. Click the Documentation tab.
  4. Optional: Upload an icon to associate with this component.

    Note: The icon file must be a .png, .jpg, or a .bmp file. The icon file size must be 3 MB or smaller. The icon must be exactly 120 pixels high and 120 pixels wide.

    1. In the Overview section, click Upload icon.
    2. Click Choose File.
    3. Select the icon file, and click Open.
    4. Click Submit.
  5. Enter a Description of the component.
  6. In the Key features section, enter a key feature of the component to help users understand what it does. Click Add new to add additional features.
  7. Upload a PDF file with a maximum size of 25 MB that provides information about this component.
    1. Optional: Click download template to download a documentation template. Click download example to see a sample installation guide.
    2. Click Upload.
    3. Click Choose File.
    4. Select the file you want to add, and click Open.
    5. Click Submit.
  8. Click Save.
Did you find this content helpful? YesNo

Have a question? Get answers now.

Visit the Collaboration Center to ask questions, engage in discussions, share ideas, and help others.

Ready to crush complexity?

Experience the benefits of Pega Community when you log in.

We'd prefer it if you saw us at our best. is not optimized for Internet Explorer. For the optimal experience, please use:

Close Deprecation Notice
Contact us