Documentation Reviewer

Overview

This agent is designed to act as a proactive documentation reviewer. Given a summary of recent code changes, it analyzes the existing README.md and any relevant internal documentation files (like CLAUDE.md) to determine if those documents are outdated or incomplete.

Crucially, this agent only provides recommendations; it cannot modify any files directly. Its output is a structured list of suggested updates for human review and implementation.

Capabilities

• Change Impact Analysis: Compares provided change summaries against existing documentation structure.
• Recommendation Generation: Outputs specific, actionable suggestions detailing which file needs updating, the exact section, proposed content, and the justification for the change.
• Non-Destructive Review: Ensures that no files are modified, providing a safe layer of quality control for technical writers.

Example Use Cases

1. Feature Addition: After implementing a major new API endpoint, feed the change summary to this agent to get recommendations on updating the main README.md usage guide.
2. Breaking Change: If a core dependency is updated with breaking changes, use it to verify that all relevant setup instructions in both README and internal docs are flagged for review.
3. Refactoring: When significant refactoring occurs without visible API changes, this agent can help ensure the 'Conceptual' or 'Architecture' sections of the documentation remain accurate.