claude-md-improver

claude-md-improver

热门

审计并改进仓库中的 CLAUDE.md 文件。当用户要求检查、审计、更新、改进或修复 CLAUDE.md 文件时使用。扫描所有 CLAUDE.md 文件,根据模板评估质量,输出质量报告,然后进行针对性更新。当用户提到“CLAUDE.md 维护”或“项目记忆优化”时也使用。

3.3万Star
3701Fork
更新于 2026/7/30
SKILL.md
readonly只读
name
claude-md-improver
description

审计并改进仓库中的 CLAUDE.md 文件。当用户要求检查、审计、更新、改进或修复 CLAUDE.md 文件时使用。扫描所有 CLAUDE.md 文件,根据模板评估质量,输出质量报告,然后进行针对性更新。当用户提到“CLAUDE.md 维护”或“项目记忆优化”时也使用。

CLAUDE.md 改进器

审计、评估并改进代码库中的 CLAUDE.md 文件,确保 Claude Code 拥有最佳的项目上下文。

此技能可以写入 CLAUDE.md 文件。 在呈现质量报告并获得用户批准后,它会以针对性改进更新 CLAUDE.md 文件。

工作流程

阶段 1:发现

查找仓库中所有 CLAUDE.md 文件:

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

文件类型与位置:

类型 位置 用途
项目根目录 ./CLAUDE.md 主要项目上下文(纳入 git,与团队共享)
本地覆盖 ./.claude.local.md 个人/本地设置(被 gitignore,不共享)
全局默认 ~/.claude/CLAUDE.md 跨所有项目的用户级默认设置
包特定 ./packages/*/CLAUDE.md 单体仓库中的模块级上下文
子目录 任意嵌套位置 功能/领域特定上下文

注意: Claude 会自动发现父目录中的 CLAUDE.md 文件,使单体仓库设置自动生效。

阶段 2:质量评估

对每个 CLAUDE.md 文件,根据质量标准进行评估。详细评分标准见 references/quality-criteria.md

快速评估检查表:

标准 权重 检查项
命令/工作流已记录 是否存在构建/测试/部署命令?
架构清晰度 Claude 能否理解代码库结构?
非明显模式 是否记录了陷阱和怪癖?
简洁性 是否没有冗长解释或明显信息?
时效性 是否反映当前代码库状态?
可操作性 指令是否可执行,而非模糊?

质量评分:

  • A (90-100):全面、最新、可操作
  • B (70-89):覆盖良好,有少量缺口
  • C (50-69):基本信息,缺少关键部分
  • D (30-49):稀疏或过时
  • F (0-29):缺失或严重过时

阶段 3:质量报告输出

在进行任何更新之前,务必输出质量报告。

格式:

## CLAUDE.md 质量报告

### 摘要
- 找到的文件数:X
- 平均得分:X/100
- 需要更新的文件数:X

### 逐文件评估

#### 1. ./CLAUDE.md(项目根目录)
**得分:XX/100(等级:X)**

| 标准 | 得分 | 备注 |
|-----------|-------|-------|
| 命令/工作流 | X/20 | ... |
| 架构清晰度 | X/20 | ... |
| 非明显模式 | X/15 | ... |
| 简洁性 | X/15 | ... |
| 时效性 | X/15 | ... |
| 可操作性 | X/15 | ... |

**问题:**
- [列出具体问题]

**建议添加:**
- [列出应添加的内容]

#### 2. ./packages/api/CLAUDE.md(包特定)
...

阶段 4:针对性更新

输出质量报告后,在更新前请求用户确认。

更新指南(关键):

  1. 仅提议针对性添加 - 专注于真正有用的信息:

    • 分析过程中发现的命令或工作流
    • 代码中发现的陷阱或非明显模式
    • 之前不清晰的包关系
    • 有效的测试方法
    • 配置怪癖
  2. 保持最小化 - 避免:

    • 重复代码中显而易见的内容
    • 已涵盖的通用最佳实践
    • 不太可能重复的一次性修复
    • 一行即可的冗长解释
  3. 显示差异 - 对每个更改,显示:

    • 要更新的 CLAUDE.md 文件
    • 具体添加内容(以差异或引用块形式)
    • 简要说明为什么这有助于未来的会话

差异格式:

### 更新:./CLAUDE.md

**原因:** 缺少构建命令,导致对如何运行项目产生困惑。

```diff
+ ## 快速开始
+
+ ```bash
+ npm install
+ npm run dev  # 在端口 3000 上启动开发服务器
+ ```

#### 阶段 5:应用更新

用户批准后,使用 Edit 工具应用更改。保留现有内容结构。

### 模板

按项目类型的 CLAUDE.md 模板见 [references/templates.md](references/templates.md)。

### 常见需标记的问题

1. **过时命令**:不再有效的构建命令
2. **缺少依赖**:未提及的必要工具
3. **过时架构**:已更改的文件结构
4. **缺少环境设置**:所需的环境变量或配置
5. **损坏的测试命令**:已更改的测试脚本
6. **未记录的陷阱**:未捕获的非明显模式

### 分享给用户的提示

在呈现建议时,提醒用户:

- **`#` 键快捷键**:在 Claude 会话中,按 `#` 让 Claude 自动将学习内容纳入 CLAUDE.md
- **保持简洁**:CLAUDE.md 应易于人类阅读;密集优于冗长
- **可操作命令**:所有记录的命令应可直接复制粘贴
- **使用 `.claude.local.md`**:用于不与团队共享的个人偏好(添加到 `.gitignore`)
- **全局默认**:将用户级偏好放在 `~/.claude/CLAUDE.md`

### 优秀 CLAUDE.md 的特征

**关键原则:**
- 简洁且易于人类阅读
- 可复制粘贴的可操作命令
- 项目特定模式,而非通用建议
- 非明显的陷阱和警告

**推荐部分**(仅使用相关部分):
- 命令(构建、测试、开发、lint)
- 架构(目录结构)
- 关键文件(入口点、配置)
- 代码风格(项目约定)
- 环境(所需变量、设置)
- 测试(命令、模式)
- 陷阱(怪癖、常见错误)
- 工作流(何时做什么)