documentation-impact-review

Reviews code changes for documentation consequences and applies bounded correctness updates.

Updated Sep 14, 2026
One-click install
npx skills add https://github.com/brendan-m-murphy/docs-doctor --skill documentation-impact-review-brendan-m-murphy
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: documentation-impact-review
Source: https://github.com/brendan-m-murphy/docs-doctor/tree/main/.agents/skills/documentation-impact-review
Command: npx skills add https://github.com/brendan-m-murphy/docs-doctor --skill documentation-impact-review-brendan-m-murphy

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve? Software changes often silently invalidate existing documentation, leaving readers with false guidance. This Skill traces a code, CLI, schema, or workflow change to every affected reader-facing contract and decides whether documentation needs no update, an immediate fix, or a fix plus a later synthesis. ## Core Features & Use Cases - Change-to-documentation tracing: Inspects diffs against a specified base and maps altered APIs, CLI options, schemas, and workflows to affected docs pages, navigation, and examples. - Three-outcome decision: Returns exactly one of no impact, update now, or update now + synthesis, with evidence-based reasoning and bounded deferred work. - Authorized bounded edits: When edits are permitted, applies minimal documentation corrections while preserving repository format, terminology, and generated-file policy, then validates with the project's own checks (Sphinx builds, doctests, Ruff, Vale). - Use Case: Before merging a pull request that renames a CLI flag and changes a default value, run this Skill against origin/main to find every tutorial, reference page, and help text that must change, and apply the corrections in the same branch. ## Quick Start Use $documentation-impact-review to review this branch against origin/main and make the documentation updates required for current correctness.

Frequently Asked Questions about documentation-impact-review

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

FAQPage Schema
How do I check if a code change requires documentation updates?

Run a documentation impact review against a specified diff base such as origin/main. The review traces changed APIs, CLI options, schemas, and workflows to affected docs and returns no impact, update now, or update now plus synthesis with evidence.

How to review a pull request for documentation impact?

Identify the comparison base for the pull request, then trace each changed reader-visible contract to documentation pages, navigation, and examples. The Skill reports affected locations and either makes bounded edits or lists the smallest required changes in assessment-only mode.

Does documentation impact review edit files automatically?

No, review alone is not permission to change files. The Skill first determines whether the request is assessment-only or authorizes edits, and only applies bounded documentation corrections when edits are explicitly authorized.

When should I use documentation impact review versus a documentation audit?

Use impact review for a specific change or diff, such as a pull request, where you need to keep docs correct for that change. Use a general documentation assessment when you want a broad audit of documentation needs unrelated to a particular change.

What validation runs after documentation edits are made?

The Skill uses checks already configured by the repository: building affected docs or generated help, running changed examples or doctests, running Ruff docstring checks for affected Python files, and running Vale only if the repository has adopted it.

What are the limitations of documentation impact review?

It cannot review a change whose diff or base cannot be identified safely, and it defers Python docstring object-level review to a dedicated docstring skill. It also avoids expanding a focused change into site reorganization, recording broader work as a synthesis handoff instead.