reviewing-documentation

Compare code diffs against documentation to classify required and recommended updates.

8|1|Updated Mar 28, 2026

Search Tags:#diff analysis #quality assurance #code review #documentation #technical writing

Ready to run

npx skills add https://github.com/bostonaholic/team --skill reviewing-documentation

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: reviewing-documentation
Source: https://github.com/bostonaholic/team/tree/main/skills/reviewing-documentation
Command: npx skills add https://github.com/bostonaholic/team --skill reviewing-documentation

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This skill addresses the common disconnect between code changes and their corresponding documentation, ensuring that technical writing remains accurate, actionable, and complete throughout the development lifecycle.

Core Features & Use Cases

Gap Identification: Systematically compares code diffs against existing documentation to find missing or stale information.
Prose Quality Assessment: Applies specific writing principles to evaluate readability and clarity in technical documentation.
Classification Framework: Categorizes documentation findings into REQUIRED or RECOMMENDED actions to prioritize technical debt.

Quick Start

Invoke the reviewing-documentation skill to analyze the current git diff for documentation gaps and classify any necessary updates.

Frequently Asked Questions about reviewing-documentation

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

FAQPage Schema

How do I find documentation gaps when reviewing code changes?▼

To find documentation gaps during code review, compare code diffs against existing project documentation and inline comments. This process identifies missing or stale information by checking if new APIs, changed behaviors, and configuration updates are accurately reflected.

What is the best way to keep technical documentation synchronized with the codebase?▼

Keeping technical documentation synchronized with the codebase requires systematically comparing code changes against existing docs. By classifying necessary updates into required or recommended categories, you can prioritize technical debt and ensure documentation remains accurate.

How do I assess prose quality in technical documentation?▼

Assessing prose quality in technical documentation involves applying specific writing principles to evaluate readability and clarity. This ensures that documentation impacted by code changes remains actionable and clear for users.

Can I automate documentation review for git diffs?▼

You can automate documentation review for git diffs by invoking a systematic analysis skill. It compares the current git diff against existing project documentation and classifies any necessary updates into required or recommended actions.

Does documentation-gap analysis work for configuration updates and new APIs?▼

Documentation-gap analysis works effectively for configuration updates and new APIs. It compares code changes against existing project documentation and inline comments to assess the impact and identify required or recommended documentation updates.

When should I classify documentation updates as required versus recommended?▼

You should classify documentation updates as required versus recommended to prioritize technical debt. This classification framework ensures that critical changes like new APIs or changed behaviors are addressed first, keeping documentation accurate and complete.