SuperAPI AI 工具集

claude-md-management

编程与开发

查看项目

更新于 10-15 14:42

技能介绍

用途

claude-md-management 是一个用于管理 CLAUDE.md 文件的技能。CLAUDE.md 文件是为 Claude Code 会话提供项目特定上下文的主要机制。该技能管理 CLAUDE.md 文件的完整生命周期:发现、质量评估、报告和改进,遵循五阶段工作流,确保文档保持最新、可操作且简洁。

主要能力

该技能依据六个维度的标准化质量标准评估 CLAUDE.md 文件:

标准 权重 检查内容
命令/工作流 20 分 构建/测试/部署命令是否存在且可用?
架构清晰度 20 分 Claude 能否理解代码库结构?
非显而易见模式 15 分 是否记录了陷阱和特殊之处?
简洁性 15 分 内容是否密集而无冗余?
时效性 15 分 是否反映当前代码库状态?
可操作性 15 分 指令是否可执行且可直接复制粘贴?

质量评分等级:A(90-100)、B(70-89)、C(50-69)、D(30-49)、F(0-29)。每个文件获得分数和等级,并附具体改进建议。

使用方式

该技能遵循五阶段工作流:

阶段 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 monorepo 中的模块级上下文
子目录 任意嵌套位置 功能/领域特定上下文

阶段 2:质量评估 对每个 CLAUDE.md 文件,阅读 references/quality-criteria.md 并依据上述六项标准进行评估。

阶段 3:质量报告输出 关键:始终在做出任何更新之前输出质量报告。报告格式包括摘要(找到的文件数、平均分、需要更新的文件数)和逐文件评估(分数、等级、各标准得分及备注、问题列表、建议添加内容)。

阶段 4:针对性更新 在报告输出后,更新前询问用户确认。阅读 references/update-guidelines.md 获取详细更新原则。关键原则:仅提出针对性添加(命令、陷阱、模式、配置);保持最小化(避免显而易见的信息、通用建议、一次性修复);展示差异(文件、变更 diff 格式、说明)。

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

适用场景

在以下情况使用此技能:

  • 用户明确要求“检查”、“审计”、“更新”、“改进”、“修复”或“维护” CLAUDE.md
  • 用户提及“CLAUDE.md 质量”、“文档审查”或“项目记忆优化”
  • 需要为新项目从头创建 CLAUDE.md
  • 用户询问如何改进 Claude 对代码库的理解
  • 文档已过时或陈旧
  • 开始处理新代码库并需要了解现有文档
  • 用户在会话中按下 # 将学习内容纳入 CLAUDE.md

触发短语:“audit CLAUDE.md”、“check documentation quality”、“improve project context”、“review CLAUDE.md”、“validate documentation”。

最佳实践

  1. 始终在行动前阅读 references:质量标准、模板和更新指南包含重要细节
  2. 编辑前先报告:在未呈现质量报告前绝不修改 CLAUDE.md
  3. 保留现有结构:更新时保持现有组织方式和风格
  4. 项目特定:仅添加此代码库特定的信息,而非通用建议
  5. 验证命令可用:在建议命令前,心理或实际验证其能正确执行
  6. 使用渐进式披露:保持 SKILL.md 精简,在单独文件中引用详细评分标准
  7. 一致评分:对所有文件应用相同评分标准以公平比较

限制与警告

  1. 未经批准绝不修改:编辑 CLAUDE.md 文件前始终获得用户确认
  2. 未经询问不删除内容:如建议删除,明确标记并获得批准
  3. 尊重 .claude.local.md:这些是个人设置,绝不在共享文档中建议修改它们
  4. 避免通用建议:不要添加“编写好代码”类内容,专注于项目特定模式
  5. 保持 diff 简洁:仅显示实际更改,而非整个文件内容
  6. 验证文件路径:在记录前确保所有引用的文件存在
  7. 客观评分:一致使用评分标准,不要为不完整文档抬高分数