x-validate-docs

Validate documentation changes against code changes for PRs and branches.

Updated Aug 23, 2026
One-click install
npx skills add https://github.com/edercnj/ia-dev-environment --skill x-validate-docs
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: x-validate-docs
Source: https://github.com/edercnj/ia-dev-environment/tree/main/src/main/resources/claude/skills/x-validate-docs
Command: npx skills add https://github.com/edercnj/ia-dev-environment --skill x-validate-docs

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Keeps code and documentation in sync by validating that documentation updates exist for altered code across key dimensions (readme, api, adr, skill-docs, etc.) in PRs and branches, reducing drift and review overhead.

Core Features & Use Cases

  • Validates documentation across six dimensions (readme, api, adr, skill-docs, system-architecture, and governance references) per PR.
  • Generates a structured report to a user-specified path or stdout, and exits with 0 on pass and 1 on failure for CI integration.
  • Supports story-id and PR-number filtering and scope-limiting to specific paths.

Quick Start

Run the detector on a PR to produce a report at the desired path.

Frequently Asked Questions about x-validate-docs

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

FAQPage Schema
How do I validate documentation changes against code changes in a PR?

To validate documentation changes against code in a PR, this Skill auto-detects targets and maps changed files to dimensions like readme, adr, and system-architecture. It emits a structured report and exits with status 0 or 1.

What is documentation drift and how do I prevent it in CI?

Documentation drift occurs when docs fall out of sync with code. This Skill prevents drift by validating documentation updates across six dimensions for PRs and branches, generating a report, and exiting with 1 on failure for CI integration.

Can I limit documentation validation to specific paths or stories?

Yes, you can limit documentation validation to specific paths using scope-limiting. The Skill also supports story-id and PR-number filtering to restrict validation to relevant changes.

What documentation dimensions are checked when validating code changes?

The documentation dimensions checked are readme, api, adr, skill-docs, system-architecture, and governance references. It maps changed files to these predefined dimensions to validate documentation updates.

How do I generate a documentation validation report for stdout?

To generate a validation report, run the detector on a PR or branch. It produces a structured report at a user-specified path or stdout, exiting with status 0 on pass and 1 on failure.

Do I need any dependencies to check documentation sync across branches?

No dependencies are required to check documentation sync. The Skill applies project configuration to auto-detect targets and validates changed files against documentation dimensions independently.