Documentation Test Synchronization

Overview

This agent is designed to solve a common technical debt problem: documentation that drifts away from reality. It systematically generates a comprehensive, actionable plan to synchronize all recorded test information within project documentation with the actual, executable tests present in the codebase.

Capabilities

• Gap Analysis: Compares documented test coverage/scenarios against live test files.
• Plan Generation: Outputs a multi-step remediation plan for updating outdated documentation sections.
• Self-Correction: Includes a final review step to critique and improve the generated synchronization plan itself, ensuring robustness.
• Coverage Integration: Can incorporate steps to run coverage reports and update associated metrics in the docs.

Example Use Cases

• Onboarding New Developers: When bringing a new team member up to speed, use this agent to generate an immediate audit of outdated testing guides.
• Pre-Release Audits: Before a major documentation push, run this agent to ensure all feature descriptions accurately reflect the current test suite status.
• Refactoring Cleanup: After large-scale code refactoring, execute this agent to map out exactly which documentation sections need updating due to changed underlying tests.