Claude Md Improver

secondsky/sap-skills/.agents/skills/claude-md-improver

作者 secondsky652a861d3ed422b71f01c8805f9ec03b14017cd8无许可证收录于 2026年10月9日更新于 2026年10月9日

Audit and improve CLAUDE.md files in repositories. Use when user asks to check, audit, update, improve, or fix CLAUDE.md files. Scans for all CLAUDE.md files, evaluates quality against templates, outputs quality report, then makes targeted updates. Also use when the user mentions "CLAUDE.md maintenance" or "project memory optimization".

仅含说明AI & Agents
AI 生成的概览

审查仓库中的 CLAUDE.md 文件,评估其质量,并在获得批准后应用有针对性的改进。

功能
该技能会在仓库中查找所有 CLAUDE.md 文件,包括项目根目录、本地覆盖、全局默认以及各包专属位置。它依据命令记录、架构清晰度、时效性和可执行性等加权标准评估每个文件,并在做任何修改前输出带评分的质量报告。获得用户批准后,它以差异形式应用最小化的针对性修改,补充缺失的命令、注意事项和配置说明,同时保留原有结构。它还会分享使用技巧,并引用模板与更新指南。
适用场景
当用户要求检查、审查、更新、改进或修复 CLAUDE.md 文件,或提到 CLAUDE.md 维护、项目记忆优化时使用。它适用于项目上下文文件可能过时、不完整或缺少关键命令与配置说明的仓库。
运行要求
仅包含指令,没有附带脚本。它依赖智能体的 Read、Glob、Grep、Bash 和 Edit 工具;Bash 用于查找文件,Edit 用于应用获批的修改。不需要凭据或网络访问。

CLAUDE.md Improver

Audit, evaluate, and improve CLAUDE.md files across a codebase to ensure Claude Code has optimal project context.

This skill can write to CLAUDE.md files. After presenting a quality report and getting user approval, it updates CLAUDE.md files with targeted improvements.

Workflow

Phase 1: Discovery

Find all CLAUDE.md files in the repository:

bash
find . -name "CLAUDE.md" -o -name ".claude.md" -o -name ".claude.local.md" 2>/dev/null | head -50

File Types & Locations:

TypeLocationPurpose
Project root./CLAUDE.mdPrimary project context (checked into git, shared with team)
Local overrides./.claude.local.mdPersonal/local settings (gitignored, not shared)
Global defaults~/.claude/CLAUDE.mdUser-wide defaults across all projects
Package-specific./packages/*/CLAUDE.mdModule-level context in monorepos
SubdirectoryAny nested locationFeature/domain-specific context

Note: Claude auto-discovers CLAUDE.md files in parent directories, making monorepo setups work automatically.

Phase 2: Quality Assessment

For each CLAUDE.md file, evaluate against quality criteria. See references/quality-criteria.md [blocked] for detailed rubrics.

Quick Assessment Checklist:

CriterionWeightCheck
Commands/workflows documentedHighAre build/test/deploy commands present?
Architecture clarityHighCan Claude understand the codebase structure?
Non-obvious patternsMediumAre gotchas and quirks documented?
ConcisenessMediumNo verbose explanations or obvious info?
CurrencyHighDoes it reflect current codebase state?
ActionabilityHighAre instructions executable, not vague?

Quality Scores:

  • A (90-100): Comprehensive, current, actionable
  • B (70-89): Good coverage, minor gaps
  • C (50-69): Basic info, missing key sections
  • D (30-49): Sparse or outdated
  • F (0-29): Missing or severely outdated

Phase 3: Quality Report Output

ALWAYS output the quality report BEFORE making any updates.

Format:

## CLAUDE.md Quality Report
### Summary- Files found: X- Average score: X/100- Files needing update: X
### File-by-File Assessment
#### 1. ./CLAUDE.md (Project Root)**Score: XX/100 (Grade: X)**
| Criterion | Score | Notes ||-----------|-------|-------|| Commands/workflows | X/20 | ... || Architecture clarity | X/20 | ... || Non-obvious patterns | X/15 | ... || Conciseness | X/15 | ... || Currency | X/15 | ... || Actionability | X/15 | ... |
**Issues:**- [List specific problems]
**Recommended additions:**- [List what should be added]
#### 2. ./packages/api/CLAUDE.md (Package-specific)...

Phase 4: Targeted Updates

After outputting the quality report, ask user for confirmation before updating.

Update Guidelines (Critical):

  1. Propose targeted additions only - Focus on genuinely useful info:

    • Commands or workflows discovered during analysis
    • Gotchas or non-obvious patterns found in code
    • Package relationships that weren't clear
    • Testing approaches that work
    • Configuration quirks
  2. Keep it minimal - Avoid:

    • Restating what's obvious from the code
    • Generic best practices already covered
    • One-off fixes unlikely to recur
    • Verbose explanations when a one-liner suffices
  3. Show diffs - For each change, show:

    • Which CLAUDE.md file to update
    • The specific addition (as a diff or quoted block)
    • Brief explanation of why this helps future sessions

Diff Format:

markdown
### Update: ./CLAUDE.md
**Why:** Build command was missing, causing confusion about how to run the project.
```diff+ ## Quick Start++ ```bash+ npm install+ npm run dev  # Start development server on port 3000+ ```

### Phase 5: Apply Updates
After user approval, apply changes using the Edit tool. Preserve existing content structure.
## Templates
See [references/templates.md](references/templates.md) for CLAUDE.md templates by project type.
## Common Issues to Flag
1. **Stale commands**: Build commands that no longer work2. **Missing dependencies**: Required tools not mentioned3. **Outdated architecture**: File structure that's changed4. **Missing environment setup**: Required env vars or config5. **Broken test commands**: Test scripts that have changed6. **Undocumented gotchas**: Non-obvious patterns not captured
## User Tips to Share
When presenting recommendations, remind users:
- **`#` key shortcut**: During a Claude session, press `#` to have Claude auto-incorporate learnings into CLAUDE.md- **Keep it concise**: CLAUDE.md should be human-readable; dense is better than verbose- **Actionable commands**: All documented commands should be copy-paste ready- **Use `.claude.local.md`**: For personal preferences not shared with team (add to `.gitignore`)- **Global defaults**: Put user-wide preferences in `~/.claude/CLAUDE.md`
## What Makes a Great CLAUDE.md
**Key principles:**- Concise and human-readable- Actionable commands that can be copy-pasted- Project-specific patterns, not generic advice- Non-obvious gotchas and warnings
**Recommended sections** (use only what's relevant):- Commands (build, test, dev, lint)- Architecture (directory structure)- Key Files (entry points, config)- Code Style (project conventions)- Environment (required vars, setup)- Testing (commands, patterns)- Gotchas (quirks, common mistakes)- Workflow (when to do what)
## Related Skills
- **dependency-upgrade**: Include dependency hardening policies and lockfile/security workflow guidance when improving repository CLAUDE.md files

来源与署名

来源:secondsky/sap-skills位于.agents/skills/claude-md-improver提交652a861

许可证: 无许可证

内容归原作者所有。SourceWeft 从公开仓库中收录这些内容。

举报或申请下架