review-spec

Review GitHub pull request spec documents and generate review.json output.

144|16|Updated May 3, 2026
One-click install
npx skills add https://github.com/Terry-Mao/AICodingFlow --skill review-spec-terry-mao
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: review-spec
Source: https://github.com/Terry-Mao/AICodingFlow/tree/main/.github/skills/review-spec
Command: npx skills add https://github.com/Terry-Mao/AICodingFlow --skill review-spec-terry-mao

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) components.

What problem does it solve?

This Skill automates the review and validation of spec-only GitHub pull requests, ensuring high-quality documentation without manual effort.

Core Features & Use Cases

  • Automated Spec Review: Validates spec documents based on predefined criteria.
  • Document Quality Assurance: Checks for completeness, clarity, feasibility, alignment, and consistency in specifications.
  • Use Case: Use this Skill to automatically review specifications in a GitHub PR, ensuring that all requirements are met and the documentation is clear and actionable.

Quick Start

Run the 'review-spec' skill to validate the spec document for PR #123.

Frequently Asked Questions about review-spec

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

FAQPage Schema
How do I automate spec review for GitHub pull requests?

To automate spec review for GitHub pull requests, use a script that reads PR_diff.txt and pr_description.txt to validate documentation against quality standards. It generates a review.json output to identify changed files and ensure specifications are complete and clear before merging.

What is automated document validation for pull requests?

Automated document validation for pull requests is the process of checking spec documents for completeness, clarity, feasibility, alignment, and consistency. This ensures that engineering and product development documentation meets predefined quality standards without requiring manual review effort.

What files are needed to validate spec documents in a GitHub PR?

To validate spec documents in a GitHub PR, you need to provide PR_diff.txt and pr_description.txt as input. The automation script reads these files to identify changed files and evaluate the specification content before generating its review output.

Does automated spec review check for completeness and consistency in documentation?

Yes, automated spec review checks documentation for completeness, clarity, feasibility, alignment, and consistency. By validating the specification against these predefined criteria, it ensures that all requirements are met and the documentation is actionable for engineering workflows.

How do I ensure high-quality documentation before merging a GitHub PR?

To ensure high-quality documentation before merging a GitHub PR, apply an automated spec validation script to evaluate the changes. This process reviews the pull request specifications to verify they meet quality standards and produces a structured review.json output for actionable feedback.