update-docs

Reconcile repository documentation with actual code and configuration.

Updated Apr 28, 2026
One-click install
npx skills add https://github.com/ChazzCoin/claude-kit --skill update-docs-chazzcoin
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: update-docs
Source: https://github.com/ChazzCoin/claude-kit/tree/main/kit/skills/update-docs
Command: npx skills add https://github.com/ChazzCoin/claude-kit --skill update-docs-chazzcoin

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Pause and reconcile documentation against reality. Walks every core doc — README, CLAUDE.md, DEPLOY.md, task-rules, PHASES, ROADMAP, AUDIT, .env.example, skill files — and flags what's drifted from the actual state of the code, then proposes targeted edits. Triggered when the user wants a doc-sync pass — e.g. "/update-docs", "let's check our docs", "are our docs still accurate", "make sure everything is documented properly".

Core Features & Use Cases

  • Reconciles repository documentation with the actual codebase and configuration to surface drift.
  • Targets a defined scope of docs: README.md, CLAUDE.md, DEPLOY.md, .env.example, .claude/, and task/phase/roadmap-related docs, plus skill files.
  • Use Case: Run a doc-sync pass to identify stale entries and propose surgical edits, which you approve before changes apply.

Quick Start

Activate a doc-sync pass by issuing /update-docs and reviewing the proposed changes.

Frequently Asked Questions about update-docs

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

FAQPage Schema
How do I audit my repository documentation for drift against the codebase?

A doc-sync pass compares core files like README.md, CLAUDE.md, and DEPLOY.md against actual code and configuration to surface drift. It proposes surgical edits for your approval before applying any changes to the repository.

What is documentation drift and when do I need a doc-sync pass?

Documentation drift happens when files like README.md or .env.example become outdated relative to the actual codebase. You need a doc-sync pass when verifying accuracy and reconciling stale entries with current configuration.

How do I reconcile stale README and configuration docs with current code?

Trigger an audit pass that walks through README, CLAUDE.md, DEPLOY.md, and .env.example files to identify outdated information. It proposes targeted edits that align documentation with the actual state of the code.

Can I review proposed documentation edits before they are applied to my repo?

Yes, the doc-sync process proposes surgical edits only after user approval. It reads and compares listed docs, tracks drift across core files and skill entries, and waits for your review before applying changes to the repository.

Does the documentation audit cover skill files and task rules?

Yes, the audit targets a defined scope including task-rules, PHASES, ROADMAP, .claude/ directory contents, and skill files. It walks every core doc and skill entry to flag what has drifted from the actual code and configuration state.

What is the best way to make sure everything is documented properly in a git repo?

Run a routine doc-sync session that audits README, CLAUDE.md, DEPLOY.md, and skill files against the codebase. This surfaces drift and proposes targeted edits to keep documentation accurate and synchronized with reality.