Skip to main content

Pega Marketplace Terms of Use

Technical Artifacts Generator

Generates technical documentation assets like technical documentation, rule changes, branch quality

By using or submitting listings via the Pega Marketplace, you agree to our Terms of Use.

Overview

As part of MLP1, two key automation enhancements are being delivered to improve efficiency and traceability within Pega development workflows.
The first enhancement focuses on streamlining the generation of High-Level Design (HLD) documents. Traditionally, developers manually compile these documents after completing a user story, which involves repetitive tasks like capturing screenshots, documenting rule changes, and updating test results. With the new automation, an initial draft of the HLD is generated directly from the branch, significantly reducing manual effort and accelerating documentation turnaround.
The second enhancement introduces an Auto Check-in Comment Enhancer for Rule Forms. This feature automatically appends check-in comments to the Rule Form description, along with metadata such as the check-in timestamp and developer identity. By eliminating the need for manual updates, it ensures consistent traceability of rule changes and improves overall governance of development activities.

Key Features

  • One-Click design document Generation: A button embedded in the branch view allows developers to instantly generate a draft design document document.
  • Auto-Populated Sections
  • Branch Quality Summary: Automatically includes screenshots and metrics.
  • Rule Changes Table: Lists new and updated rules with RuleSet, type (new/existing), and descriptions.
  • Unit Test Results: Includes test cases and their execution status.
  • Delta Analysis: For existing rules, compares current and previous descriptions to highlight changes.
  • Configurable Sections: Optional sections can be toggled based on project needs.
  • Auto Check-in Comment Enhancer for Rule Forms:
  • Automatic Description Update: On rule check-in, the system appends the developer’s comment to the Rule form description.
  • Metadata Enrichment:
  • Check-in Timestamp: Captures the exact date and time of the check-in.
  • Developer Identity: Includes the name of the developer who performed the check-in.
  • Audit-Friendly Format: Ensures consistent formatting for easier review and compliance tracking.
  • Category: Delivery Excellence
  • Business Value:
  • Improves Developer Productivity: Reduces manual effort and allows developers to focus on core tasks.
  • Standardization: Ensures all HLDs follow a consistent format across teams.
  • Accelerates Documentation: Provides a ready-to-edit draft that can be enriched further.
  • Enhances Quality: Minimizes human error in documentation and improves traceability.
  • Improves Traceability: Maintains a clear history of rule changes directly within the Rule form.
  • Reduces Manual Effort: Eliminates the need for developers to manually update descriptions.
  • Enhances Collaboration: Makes it easier for team members to understand recent changes and context.
  • Supports Governance: Facilitates audits and reviews with standardized metadata logging.

Resources

Installation Guide

pega_logo

Version

01.01

Compatible with

Pega Platform 24.2.2 Pega Customer Service '24.2

Support

Shakeer Mohammed

Product Owner

Aditya Boggarapu

Last updated

October 23, 2025

Product Capability

Project Delivery
Share this page Share via X Share via LinkedIn Copying...

Did you find this content helpful?

We'd prefer it if you saw us at our best.

Pega Community has detected you are using a browser which may prevent you from experiencing the site as intended. To improve your experience, please update your browser.

Close Deprecation Notice