jiamizhongshifu

claudemd-optimizer

1
0
# Install this skill:
npx skills add jiamizhongshifu/claudemd-optimizer

Or install specific skill: npx add-skill https://github.com/jiamizhongshifu/claudemd-optimizer

# Description

帮助用户优化 CLAUDE.md 文档的专业工具。当用户说"优化我的 CLAUDE.md"、"检查 CLAUDE.md"、"改进项目配置"、"CLAUDE.md 最佳实践"、"帮我写 CLAUDE.md"时触发。提供分析、诊断、模板生成和最佳实践指导。

# SKILL.md


name: claudemd-optimizer
description: 帮助用户优化 CLAUDE.md 文档的专业工具。当用户说"优化我的 CLAUDE.md"、"检查 CLAUDE.md"、"改进项目配置"、"CLAUDE.md 最佳实践"、"帮我写 CLAUDE.md"时触发。提供分析、诊断、模板生成和最佳实践指导。


CLAUDE.md 优化器

帮助用户创建和优化高效的 CLAUDE.md 文档,让 Claude 的错误率显著下降。

核心理念

"Invest in your CLAUDE.md. After every correction, end with: 'Update your CLAUDE.md so you don't make that mistake again.' Claude is eerily good at writing rules for itself."
— Boris (Claude Code 创始人)

触发方式

# 自然语言触发
"优化我的 CLAUDE.md"
"检查一下 CLAUDE.md"
"帮我写 CLAUDE.md"
"CLAUDE.md 最佳实践"
"分析项目配置文件"

工作流程

1. 诊断分析 (Diagnose)

读取用户的 CLAUDE.md,从以下维度评估:

维度 检查项 权重
完整性 是否包含项目概述、技术栈、工作流 25%
具体性 规则是否具体可执行,而非模糊描述 25%
经验沉淀 是否记录了踩坑经验和修复方案 20%
结构清晰 是否有清晰的章节组织 15%
工具集成 是否定义了 skills、hooks、MCP 配置 15%

2. 生成优化建议 (Optimize)

基于诊断结果,输出:
- 缺失的关键章节
- 可以更具体的模糊规则
- 建议添加的经验沉淀
- 结构优化建议

3. 模板生成 (Generate)

根据项目类型生成定制化模板。详见 references/templates.md

4. 持续迭代 (Iterate)

每次 Claude 犯错后,引导用户更新 CLAUDE.md:

"请将这个修复经验添加到 CLAUDE.md,这样我下次就不会犯同样的错误了。"

核心章节清单

一个优秀的 CLAUDE.md 应包含以下章节:

必备章节

章节 说明 示例
项目概述 一句话说明项目是什么 "这是一个公众号文章写作项目"
技术栈 使用的语言、框架、工具 TypeScript, Next.js, Tailwind
目录结构 关键目录的用途说明 src/components/ - UI 组件
开发命令 常用的构建、测试、运行命令 bun run dev, bun test
代码规范 命名约定、文件组织、风格要求 "组件使用 PascalCase"

进阶章节

章节 说明 示例
工作流程 多步骤任务的标准流程 写作前→写作中→写作后
经验沉淀 踩坑记录和修复方案 "Windows 下路径需要转义"
禁忌事项 明确禁止的操作 "❌ 不要直接修改 dist 目录"
Skills 集成 可用的 skills 和调用方式 /commit, /review-pr
MCP 配置 已启用的 MCP 服务器 Slack MCP, BigQuery MCP

高级章节

章节 说明 示例
并行工作流 git worktree 配置和使用 za, zb, zc 快捷键
Subagent 策略 何时使用子代理 "复杂任务使用 subagents"
计划模式规则 何时进入计划模式 "超过 3 个文件的修改先计划"
Notes 目录 任务笔记的维护规则 notes/ 目录结构

最佳实践速查

详细指南见 references/best-practices.md

规则编写原则

# ❌ 模糊规则(无效)
代码要写得好一点

# ✅ 具体规则(有效)
- 函数不超过 50 行
- 每个函数只做一件事
- 变量命名使用 camelCase
- 组件命名使用 PascalCase

经验沉淀模板

## 经验沉淀

### [日期] [问题简述]
**问题**:[具体描述]
**原因**:[根因分析]
**解决**:[修复方案]
**规则**:[新增的规则,防止再犯]

错误修复后的标准动作

每次 Claude 犯错并修复后,执行:

"Update your CLAUDE.md so you don't make that mistake again."

Claude 会自动生成防止再犯的规则。

检查清单

完整检查清单见 references/checklist.md

快速检查(5 项核心)

  • [ ] 项目概述是否清晰?(一句话能说明白)
  • [ ] 技术栈是否完整?(语言、框架、工具)
  • [ ] 开发命令是否列出?(build、test、dev)
  • [ ] 是否有经验沉淀章节?(踩坑记录)
  • [ ] 规则是否具体可执行?(非模糊描述)

输出格式

诊断报告

# CLAUDE.md 诊断报告

## 评分:XX/100

| 维度 | 得分 | 说明 |
|------|------|------|
| 完整性 | X/25 | ... |
| 具体性 | X/25 | ... |
| 经验沉淀 | X/20 | ... |
| 结构清晰 | X/15 | ... |
| 工具集成 | X/15 | ... |

## 优化建议

### 🔴 必须修复
1. ...

### 🟡 建议改进
1. ...

### 🟢 可选增强
1. ...

高级技巧

1. 让 Claude 为自己写规则

用户:你刚才犯了一个错误,请更新 CLAUDE.md 防止再犯
Claude:好的,我建议添加以下规则到 CLAUDE.md:
[自动生成的规则]

2. 维护 Notes 目录

## Notes 目录规范

每个任务/项目维护独立笔记:
- `notes/task-xxx.md` - 任务笔记
- `notes/pr-xxx.md` - PR 相关笔记

每次 PR 后更新笔记,CLAUDE.md 指向 notes 目录。

3. 计划模式触发规则

## 计划模式规则

以下情况必须先进入计划模式:
- 修改超过 3 个文件
- 涉及架构变更
- 不确定实现方案时

计划模式流程:
1. Claude A 写计划
2. Claude B 以 Staff Engineer 身份审查
3. 通过后再执行

4. Subagent 使用策略

## Subagent 策略

在请求末尾添加 "use subagents" 让 Claude 投入更多计算资源。

适用场景:
- 复杂的代码分析
- 多文件重构
- 需要深度思考的问题

参考资源

# README.md

CLAUDE.md Optimizer

A Claude Code skill that helps you create and optimize effective CLAUDE.md files, significantly reducing Claude's error rate.

English | 中文


English

What is this?

CLAUDE.md Optimizer is a skill for Claude Code that helps you:

  • Diagnose your existing CLAUDE.md with a 5-dimension scoring system
  • Optimize with actionable suggestions (must-fix / should-improve / nice-to-have)
  • Generate project-specific templates (7 types: frontend, backend, fullstack, CLI, content creation, data analysis)
  • Iterate by letting Claude write rules for itself after every mistake

Core Philosophy

"Invest in your CLAUDE.md. After every correction, end with: 'Update your CLAUDE.md so you don't make that mistake again.' Claude is eerily good at writing rules for itself."
— Boris (Creator of Claude Code)

Installation

Copy the claudemd-optimizer folder to your Claude Code skills directory:

# Global installation (available in all projects)
cp -r claudemd-optimizer ~/.claude/skills/

# Or project-level installation
cp -r claudemd-optimizer .claude/skills/

Usage

Trigger the skill with natural language:

"Optimize my CLAUDE.md"
"Check my CLAUDE.md"
"Help me write a CLAUDE.md"
"CLAUDE.md best practices"

Scoring Dimensions

Dimension Weight Description
Completeness 25% Project overview, tech stack, workflow
Specificity 25% Rules are concrete and actionable
Experience Log 20% Documented pitfalls and solutions
Structure 15% Clear section organization
Tool Integration 15% Skills, hooks, MCP configuration

Project Templates

  • Universal - Basic framework for any project
  • Frontend - React/Vue/Next.js projects
  • Backend - Node.js/Python API projects
  • Fullstack - Integrated frontend + backend
  • CLI Tool - Command-line applications
  • Content Creation - Writing, docs, blogs
  • Data Analysis - Data processing projects

File Structure

claudemd-optimizer/
├── SKILL.md                 # Main skill definition
└── references/
    ├── best-practices.md    # Writing guidelines
    ├── templates.md         # Project templates
    └── checklist.md         # Evaluation checklist

中文

这是什么?

CLAUDE.md Optimizer 是一个 Claude Code 技能,帮助你:

  • 诊断 现有 CLAUDE.md,提供 5 维度评分
  • 优化 输出可执行的建议(必须修复 / 建议改进 / 可选增强)
  • 生成 项目定制化模板(7 种类型:前端、后端、全栈、CLI、内容创作、数据分析)
  • 迭代 让 Claude 在每次犯错后为自己写规则

核心理念

"投资你的 CLAUDE.md。每次纠正后,以这句话结尾:'更新你的 CLAUDE.md,这样你就不会再犯同样的错误了。' Claude 非常擅长为自己写规则。"
— Boris(Claude Code 创始人)

安装

claudemd-optimizer 文件夹复制到 Claude Code skills 目录:

# 全局安装(所有项目可用)
cp -r claudemd-optimizer ~/.claude/skills/

# 或项目级安装
cp -r claudemd-optimizer .claude/skills/

使用方法

用自然语言触发:

"优化我的 CLAUDE.md"
"检查一下 CLAUDE.md"
"帮我写 CLAUDE.md"
"CLAUDE.md 最佳实践"

评分维度

维度 权重 说明
完整性 25% 项目概述、技术栈、工作流
具体性 25% 规则具体可执行
经验沉淀 20% 踩坑记录和解决方案
结构清晰 15% 章节组织清晰
工具集成 15% Skills、hooks、MCP 配置

项目模板

  • 通用模板 - 任何项目的基础框架
  • 前端项目 - React/Vue/Next.js 等
  • 后端项目 - Node.js/Python API 等
  • 全栈项目 - 前后端一体化
  • CLI 工具 - 命令行工具项目
  • 内容创作 - 写作、文档、博客
  • 数据分析 - 数据处理项目

文件结构

claudemd-optimizer/
├── SKILL.md                 # 主技能定义
└── references/
    ├── best-practices.md    # 编写指南
    ├── templates.md         # 项目模板
    └── checklist.md         # 检查清单

Contributing

Issues and PRs are welcome!

License

MIT License - see LICENSE for details.

Acknowledgments

  • Inspired by tips from the Claude Code team
  • Based on real-world experience optimizing CLAUDE.md files

# Supported AI Coding Agents

This skill is compatible with the SKILL.md standard and works with all major AI coding agents:

Learn more about the SKILL.md standard and how to use these skills with your preferred AI coding agent.