pr-tech-spec-generator

Generate structured Markdown technical specifications from GitHub PRs using gh CLI and git.

Updated Aug 27, 2026
One-click install
npx skills add https://github.com/atman-33/skills --skill pr-tech-spec-generator
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: pr-tech-spec-generator
Source: https://github.com/atman-33/skills/tree/main/skills/pr-tech-spec-generator
Command: npx skills add https://github.com/atman-33/skills --skill pr-tech-spec-generator

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) components.

What problem does it solve?

This tool automates the creation of comprehensive technical specifications from GitHub Pull Requests, replacing manual, error-prone documentation efforts with an automated, repeatable process.

Core Features & Use Cases

  • Analyze PR metadata, commits, and diffs using gh CLI and git to produce a structured Markdown specification.
  • Detect and summarize changes across folders, the DB schema, APIs, tests, and dependencies for quick impact assessment.
  • Real-world use: given a PR with schema and API changes, generate a complete spec including folder structure, change history, and impact analysis for reviewers and onboarding docs.

Quick Start

Run the spec generator for a PR: python scripts/generate_spec.py https://github.com/owner/repo/pull/123 Optionally specify the repository path: python scripts/generate_spec.py https://github.com/owner/repo/pull/123 --repo-path /path/to/repo Optionally specify an output directory: python scripts/generate_spec.py https://github.com/owner/repo/pull/123 --output-dir /path/to/output

Frequently Asked Questions about pr-tech-spec-generator

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

FAQPage Schema
How do I generate a technical specification from a GitHub pull request?

To generate a technical specification from a GitHub pull request, run the provided Python script with the PR URL to automatically fetch metadata, compute diffs, and compile a structured Markdown document detailing the changes.

What is included in an automated PR technical spec?

An automated PR technical spec includes a comprehensive overview, change summary, folder structure, commit history, and categorized changes such as DB schema and API modifications for impact assessment.

Do I need gh CLI and local git access to analyze PR diffs?

Yes, you need both the gh CLI and local git access to fetch PR data and compute diffs, as the specification generator relies on these tools to extract repository information and compile the final Markdown document.

Can I specify a custom output directory for generated PR documentation?

Yes, you can specify a custom output directory for generated PR documentation by passing the `--output-dir` argument with your desired path when executing the Python specification generation script.

What is the best way to automate change analysis for onboarding documentation?

Automating change analysis for onboarding documentation is best achieved by running this script against PRs with schema or API changes, which produces a complete structured Markdown spec for reviewers and new team members.

How do I analyze a specific local repository path during PR spec generation?

To analyze a specific local repository path during PR spec generation, use the `--repo-path` argument followed by your local directory path when running the Python script to ensure accurate diff computation.