docs-update

Audits project documentation against the codebase and generates a structured revision plan.

7|Updated May 28, 2026

Search Tags:#documentation #refactoring #codebase #audit #readme #sync

Ready to run

npx skills add https://github.com/zcaceres/skills --skill docs-update-zcaceres

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: docs-update
Source: https://github.com/zcaceres/skills/tree/main/plugins/quality/skills/docs-update
Command: npx skills add https://github.com/zcaceres/skills --skill docs-update-zcaceres

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This skill solves the common issue of documentation rot, where project READMEs and guides become outdated as the codebase evolves, leading to confusion and wasted developer time.

Core Features & Use Cases

Automated Audit: Scans project documentation and compares it against the actual directory structure, dependencies, and API surface.
Revision Planning: Generates a structured plan to fix, add, or remove documentation based on codebase ground truth.
Use Case: Use this when you have refactored your project structure or added new features and need to ensure your README and docs reflect the current state of the code.

Quick Start

Ask the agent to update the project documentation to ensure it matches the current codebase.

Frequently Asked Questions about docs-update

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

FAQPage Schema

How do I sync my project documentation with the current codebase?▼

Documentation rot occurs when project READMEs and guides become outdated as the codebase evolves, leading to developer confusion and wasted time. Auditing your documentation against the actual codebase state resolves this by identifying discrepancies and generating a revision plan.

What is the best way to update a README after refactoring project structure?▼

After refactoring, an automated audit scans your project documentation and compares it against the actual directory structure and dependencies. It generates a structured revision plan to fix, add, or remove outdated documentation based on codebase ground truth.

How does parallel agent execution verify documentation claims against code?▼

Parallel agent execution verifies documentation claims by analyzing directory structures, dependencies, and API interfaces simultaneously against real-world code implementation. This ensures your documented APIs and guides accurately reflect the actual codebase state.

Can I audit API surface documentation against actual code implementation?▼

Yes, you can audit API surface documentation by scanning project docs and comparing them against actual API interfaces in the codebase. This identifies discrepancies and generates a structured revision plan to resolve outdated or missing information.

Do I need parallel agent execution to identify documentation discrepancies?▼

Yes, parallel agent execution is required to verify documentation claims against real-world code implementation. This approach analyzes directory structures, dependencies, and API interfaces concurrently to accurately identify and resolve discrepancies.