skills.rest
rayshan
rayshanCOMMUNITY
Explore all skills by this author →
Website𝕏@rayshanGitHub

update-docs

Revise CLAUDE.md and audit README.md files against the current codebase.

Updated Aug 23, 2026
Search Tags:#documentation#diff#update#README#CLAUDE.md#proposal#approval
One-click install
npx skills add https://github.com/rayshan/agent-plugins --skill update-docs-rayshan
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: update-docs
Source: https://github.com/rayshan/agent-plugins/tree/main/ray-agent-plugins/skills/update-docs
Command: npx skills add https://github.com/rayshan/agent-plugins --skill update-docs-rayshan

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This skill updates project documentation to reflect the current codebase state, ensuring CLAUDE.md and README.md remain accurate after feature work, refactors, or when documentation becomes stale.

Core Features & Use Cases

  • Revise CLAUDE.md using the dedicated management workflow to capture learnings and keep docs up to date.
  • Review all README.md files to verify relevance and accuracy, ensuring installation steps, usage examples, and descriptions match the codebase.
  • Propose README changes in a diff-style format and present them for approval before edits.

Quick Start

Run the update-docs skill to revise CLAUDE.md and generate README change proposals for the repository.

Frequently Asked Questions about update-docs

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

FAQPage Schema
How do I keep README and CLAUDE.md documentation in sync with the codebase after a refactor?▼

To keep documentation in sync after a refactor, this skill audits CLAUDE.md and README files, verifying accuracy and generating diff-style change proposals for your approval before applying edits.

What is the best way to update stale project documentation across multiple README files?▼

The best way to update stale README files is to audit them for relevance and accuracy, checking that installation steps and usage examples match the codebase, then presenting diff-style changes for approval.

How does the CLAUDE.md revision process work when updating project documentation?▼

The CLAUDE.md revision process works by using a designated management workflow to capture project learnings, ensuring the file accurately reflects the current codebase state after feature work or refactors.

Can I review documentation changes before they are applied to my README files?▼

Yes, you can review changes because this skill proposes README updates in a diff-style format and presents them for approval before any edits are made to the repository files.

When should I run a documentation update workflow for my repository?▼

You should run a documentation update workflow after completing feature work or refactors, or whenever your CLAUDE.md and README.md files become stale and no longer match the codebase.

Related Skills

Explore More Content & Communication Skills→
terzigoluterzigolu
37

write-tech-spec

Draft a TECH.md specification for a Warp feature from codebase research.

Community
Advanced
base44base44
86

sync-cli-skill

Detect changes between local and stored Base44 CLI source via git-diff.

Official
Advanced
asachs01asachs01
1

sortyourselfout

Capture and persist session learnings into user-level and project-level CLAUDE.md files.

Community
Intermediate
Prathmesh2000Prathmesh2000
1

document-expert

Audits and updates API docs, READMEs, and architecture documents for consistency.

Community
Advanced