How to use Cubyts to create Functional documentation for Merged PRs?

Overview

Functional Documentation in Cubyts automatically captures the business intent and functional behavior of delivered code.
 Documentation is generated after a pull request is merged, ensuring it always reflects the final, accepted implementation.

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

What Is Generated

Cubyts generates functional documentation that describes:

• Business intent of the change

• Functional behavior introduced by the PR

The documentation reflects the final merged code, not intermediate development states.

When Is Functional Documentation Generated?

Functional documentation is generated only when the Functional 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 Functional Documentation Is Generated

Once a pull request is merged, Cubyts:

1. Analyzes the merged code

2. Evaluates linked planning artifacts (Jira / Azure DevOps)

3. Determines the appropriate documentation type

4. Generates and publishes functional documentation automatically
   
   

No manual authoring is required from developers.

Complete vs Delta Documentation

Cubyts automatically determines the type of documentation to generate:

Complete Documentation

Generated when:

• No prior intent or specification exists for the code

Delta Documentation

Generated when:

• The PR is linked to an existing work item

• The code has progressed beyond the documented specification

• Only the functional changes introduced by the PR are captured

This decision is fully automated.

Route to the Outcome

All generated functional documentation is linked back to the merged pull request, creating a clear trace from:

Pull Request → Functional Documentation → Delivery Artifact

Viewing the Outcome

Merged PR Documentation Log

To verify functional documentation generation:

1. Navigate to Reports → Merged PR Documentation Log

2. Locate the merged PR

3. Check the Functional Documentation column

   1. Populated column → Functional documentation has been generated

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

Accessing the Generated Documentation

• Click on the entry in the Functional Documentation column

• The generated functional document opens for review

• The document reflects:

  • Final accepted behavior

  • Functional changes introduced by the PR

  • Alignment with delivery artifacts

Governance Enabler: Functional Documentation Flag

Functional Documentation is enforced through the Flag for Functional Documentation (Title: Missing functional documentation for Merged PR, belonging to the Code category).

This flag defines:

• When documentation is generated

• How documentation is generated

• Where documentation is stored

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 creating functional documentation

• When disabled:

  • No documentation is generated
    
    

Documentation Format

Administrators can configure the documentation format, such as:

• User Story

• Functional Requirement

• Feature Specification

Generated documentation always follows the selected format.

Publishing Destination

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

• A new Jira / Azure DevOps work item linked to the PR

• An existing work item associated with the PR

This ensures consistent storage and traceability.

Best Practices

• Always enable Auto Resolution for Functional Documentation

• Link PRs to planning work items for accurate delta documentation

• Standardize documentation formats across teams

• Use the Merged PR Documentation Log for audits and reviews
  
  

Benefits

• Eliminates missing functional documentation

• Keeps documentation aligned with delivered code

• Enforces governance automatically

• Improves audit readiness and traceability

• Reduces manual documentation effort
  
  

Conclusion

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

By combining intelligent generation, clear outcome visibility, and policy-driven enforcement, Cubyts ensures functional documentation is always accurate, traceable, and enterprise-ready.