Does this skill work with open pull requests?

To ensure documentation accuracy, the skill specifically filters for and analyzes merged pull requests, skipping open, draft, or closed-but-not-merged PRs.

Can I customize which sections are generated?

Yes, the skill is designed to generate specific sections like Architecture, Testing, or Usage based on the requirements of the calling command.

Does it require specific Jira permissions?

The user must have read access to the relevant Jira issues and linked GitHub repositories via their configured MCP and CLI credentials.

Where does the skill save the final documentation?

The generated documentation is saved as a Markdown file in the '.work/jira/feature-doc/' directory within your local workspace.

What prerequisites are needed for this skill?

You need a configured MCP Jira server and the GitHub CLI (gh) installed and authenticated on your local machine.

Jira Feature Documentation Generator

Name: Jira Feature Documentation Generator
Author: openshift-eng

byopenshift-eng

•

Learning & Documentation

Generates comprehensive technical documentation by recursively analyzing Jira features and their linked GitHub pull requests.

The Jira Feature Documentation Generator is a specialized skill designed to automate the creation of detailed technical documentation. By analyzing a root Jira issue, its sub-tasks, and all associated merged GitHub pull requests, the skill synthesizes high-level architecture, implementation details, usage guides, and testing strategies into a structured Markdown file. It eliminates the manual effort of hunting through PR diffs and Jira comments to understand how a feature was built, providing a cohesive narrative of the technical implementation for developers and stakeholders.

Key Features

01Automated synthesis of Architecture, Implementation, and Usage sections

02Intelligent GitHub PR filtering to analyze only merged, non-draft contributions

0329 GitHub stars

04Recursive analysis of Jira issue hierarchies and linked sub-tasks

05Full attribution for contributors and links to original Jira and GitHub resources

06Extraction of code snippets, API changes, and design decisions from PR diffs

Use Cases

01Standardizing release documentation for audit and compliance requirements

02Generating a technical post-mortem or summary after a large feature launch

03Creating developer-facing documentation for complex architectural changes

What are Skills?·How to Install

Install with 🐟 Skill.Fish

npx skillfish add openshift-eng/ai-helpers jira-doc-generator

For use in Claude.ai and ChatGPT

Download Skill