AgentSkillsCN

update-docs

在完成功能开发、代码重构，或文档内容已过时时，更新项目文档（CLAUDE.md 和 README.md），使其与当前代码库状态保持一致。

SKILL.md
--- frontmatter
name: update-docs
description: Update project documentation (CLAUDE.md and README.md) to reflect the current codebase state. Use after completing features, refactoring, or when documentation is stale.
disable-model-invocation: true
allowed-tools: Read, Edit, Glob, Skill

Update project documentation to reflect the current state of the codebase.

Step 1: Revise CLAUDE.md

Invoke the /claude-md-management:revise-claude-md skill using the Skill tool to capture session learnings and update CLAUDE.md files. Complete this step before proceeding.

Step 2: Review README.md

After CLAUDE.md updates are complete, find all README.md files:

For each README.md, verify:

  • •Relevance: Content reflects the current project state
  • •Accuracy: Installation steps, usage examples, and descriptions are correct
  • •No overlap with CLAUDE.md: README is for humans (installation, usage, features); CLAUDE.md is for Claude (development patterns, commands, gotchas)

Step 3: Propose README Changes

Show proposed changes in diff format:

code
### Update: ./README.md

**Why:** [one-line reason]

\`\`\`diff
- [removed content]
+ [added content]
\`\`\`

Step 4: Apply with Approval

Present all proposed changes and request user approval before editing files.

Guidelines

  • •Keep docs minimal - only material and critical information
  • •One line per concept where possible
  • •Remove outdated or redundant content