How to use Cubyts to generate Technical documentation for Merged PRs?

Overview

Technical Documentation in Cubyts automatically captures implementation-level details of delivered code after a pull request is merged. Documentation is generated post-merge to ensure it always reflects the final, accepted implementation, not intermediate development states.

This capability eliminates missing or outdated technical documentation while enforcing governance through automation.

What Is Generated

Cubyts generates technical documentation that can include:

• High-level technical overview

• Modifications introduced by the PR

• Breaking changes

• API documentation

• Database changes

• Configuration changes

• Dependency updates

• Feature compliance and operational considerations

The generated documentation reflects the final merged code.

When Is Technical Documentation Generated?

Technical documentation is generated only when the Technical Documentation flag is enabled with Auto Resolution turned ON.

Auto Resolution is mandatory.If auto resolution is disabled, the flag does not generate documentation.

How Technical Documentation Is Generated

Once a pull request is merged, Cubyts:

1. Analyzes the merged code and its technical footprint

2. Identifies relevant technical changes across the repository

3. Generates documentation based on configured topics

4. Publishes the documentation automatically

Developers are not required to manually author or maintain technical documentation.

Topic-Based Documentation Generation

Technical documentation is generated using configured topics, which define what is documented.

Standard Topics

Examples include:

• Overview

• Modifications made

• Breaking changes

• API documentation

• Database documentation

• Configuration changes

• Dependencies

• Feature compliance

Custom Topics

Teams can define custom technical topics aligned to their architecture, frameworks, or internal standards.

All selected topics are included automatically during documentation generation.

Route to the Outcome

All generated technical documentation is associated with the merged pull request, creating clear traceability from:

Pull Request → Technical Documentation → Delivery Artifact

Viewing the Outcome

Merged PR Documentation Log

To verify technical documentation generation:

1. Navigate to Reports → Merged PR Documentation Log

2. Locate the merged pull request

3. Check the Technical Documentation column

   1. Populated column → Technical documentation has been generated

   2. Empty column → No technical documentation exists for that PR

Accessing the Generated Documentation

• Click on the entry in the Technical Documentation column

• The generated technical document opens for review

• The document captures the implementation details introduced by the PR

Governance Enabler: Technical Documentation Flag

Technical Documentation is enforced using the Flag for Technical Documentation (Title: Missing technical documentation for Merged PR, belonging to the Code category).

This flag defines:

• When documentation is generated

• What technical topics are included

• Where documentation is published

Auto Resolution (Mandatory)

• The flag works only when Auto Resolution is enabled

• Auto resolution is the enforcement mechanism

• When enabled:

  • Cubyts resolves the flag by generating technical documentation

• When disabled:

  • No documentation is generated

Topic Configuration

Administrators can configure:

• Standard technical topics

• Custom team-specific topics

This ensures documentation aligns with organizational and architectural standards.

Publishing Destination

The flag configuration also defines where documentation is stored, such as:

• PR comments in GitHub, GitLab, or Bitbucket

• Planning tools such as Jira or Azure Boards

This ensures documentation is accessible where teams already work.

Best Practices

• Always enable Auto Resolution for Technical Documentation

• Standardize technical topics across teams

• Use custom topics for architecture-specific needs

• Review documentation via the Merged PR Documentation Log

• Use documentation logs for audits and post-release reviews

Benefits

• Eliminates missing technical documentation

• Keeps documentation aligned with delivered code

• Enforces governance automatically

• Improves traceability and audit readiness

• Reduces manual documentation effort

Conclusion

Technical Documentation in Cubyts transforms documentation from a manual, error-prone activity into a governed, automated post-merge outcome.

By combining topic-driven generation, outcome visibility, and policy-based enforcement, Cubyts ensures technical documentation is always accurate, traceable, and aligned with the delivered code.

Video link: https://www.loom.com/share/63963d2092614920815f53f02747755e