skills.rest
openshift-eng
openshift-engCOMMUNITY
Explore all skills by this author →
WebsiteGitHub

Jira Feature Documentation Generator

Generate feature documentation markdown from Jira issues and merged GitHub pull requests.

112|305|Updated Oct 10, 2025
Search Tags:#documentation#github#jira#code-review#feature-analysis#pull-requests#documentation-generation
One-click install
npx skills add https://github.com/openshift-eng/ai-helpers --skill jira-feature-documentation-generator
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: Jira Feature Documentation Generator
Source: https://github.com/openshift-eng/ai-helpers/tree/main/plugins/jira/skills/jira-doc-generator
Command: npx skills add https://github.com/openshift-eng/ai-helpers --skill jira-feature-documentation-generator

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill requires jq, gh.

What problem does it solve?

This Skill eliminates the manual effort of documenting complex Jira features by automatically analyzing all related issues and pull requests to generate structured, comprehensive documentation.

Core Features & Use Cases

  • Automated Documentation: Recursively analyzes Jira features and all related GitHub pull requests to generate detailed implementation guides.
  • PR Analysis: Extracts implementation details, design decisions, and code changes from merged pull requests.
  • Use Case: When you have a completed feature like OCPSTRAT-1612 with multiple linked PRs, this Skill automatically generates complete documentation covering architecture, implementation, testing, and usage.

Quick Start

Use the Jira Feature Documentation Generator skill to analyze feature OCPSTRAT-1612 and generate comprehensive documentation from all its related issues and pull requests.

Frequently Asked Questions about Jira Feature Documentation Generator

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I automatically generate documentation from Jira features and GitHub pull requests?▼

Generate documentation by analyzing a Jira feature and recursively extracting data from linked issues and merged pull requests. The Skill synthesizes this information into structured markdown covering architecture, implementation, testing, and usage details without manual effort.

Can I document completed features with multiple related pull requests in Jira?▼

Yes. This Skill handles complex features with main issues, sub-issues, and multiple merged PRs. It extracts implementation details from each PR and combines them into comprehensive feature documentation automatically.

What information does the Skill extract from pull requests for documentation?▼

The Skill extracts implementation details, design decisions, and code changes from merged pull requests linked to Jira features, filtering for completed work and organizing findings into actionable documentation content.

What do I need to set up before using this documentation generator?▼

You need jq and gh CLI tools installed, access to a Jira environment with feature issues, and linked GitHub pull requests. The Skill validates these prerequisites and requires at least one merged PR for analysis.

Does this approach work for features still in progress or only completed ones?▼

This Skill focuses on completed features with merged pull requests. It filters for MERGED status to ensure documentation reflects implemented work, making it unsuitable for in-progress or draft features.

Related Skills

Explore More Software Engineering Skills→
openshift-engopenshift-eng
112

Jira Pull Request Extractor

Discover Jira issues recursively and extract GitHub Pull Request links into deduplicated JSON.

Community
Advanced
officebeatsofficebeats
8

document-exporter

Convert Markdown files to PDF, HTML, and DOCX with embedded assets.

Community
Intermediate
prismaprisma
419

create-pr

Generate GitHub pull requests with conventional commit titles and narrative descriptions.

Official
Advanced
pontschopontscho
1

p:c-cpp-guidelines

Enforce C/C++ coding best practices for memory management, documentation, and static analysis.

Community
Intermediate