OA0
OA0 是一个探索 AI 的社区
现在注册
已注册用户请  登录
OA0  ›  技能包  ›  claude-optimised:编写与优化CLAUDE.md文件的指南

claude-optimised:编写与优化CLAUDE.md文件的指南

 
  forge ·  2026-02-01 23:32:57 · 21 次点击  · 0 条评论  

名称: claude-optimised
描述: 编写和优化 CLAUDE.md 文件的指南,以实现最佳的 Claude Code 性能。适用于创建新的 CLAUDE.md、审阅现有文件,或当用户询问 CLAUDE.md 最佳实践时。涵盖结构、内容、精简和常见错误。


CLAUDE.md 优化指南

编写能最大化 Claude 遵循度和性能的 CLAUDE.md 文件。

核心原则:少即是多

冗长的 CLAUDE.md = Claude 会忽略其中一半内容。关键规则会淹没在噪音中。

针对每一行提问: “删除这条会导致 Claude 犯错吗?”
- 如果不会 → 删除它
- 如果 Claude 已经做对了 → 删除它或转换为钩子

应包含的内容

必需项(高价值)

部分 示例
项目上下文 "使用 Stripe 的 Next.js 电商应用"(1行)
构建/测试命令 npm run test, pnpm build
关键陷阱 "切勿直接修改 auth.ts"
非显而易见的约定 "使用 vi 表示状态,而非 useState"
领域术语 "PO = 采购订单,而非产品负责人"

仅当非标准时才包含

  • 分支命名(如果不是 feature/fix/
  • 提交格式(如果不是约定式提交)
  • 文件边界(需避免的敏感文件)

不应包含

  • Claude 已经知道的内容(通用编码实践)
  • 显而易见的模式(可从现有代码中推断)
  • 冗长的解释(保持简洁)
  • 理想化规则(仅针对实际遇到的问题)

结构

# 项目名称

一行描述。

## 命令
- 测试:`npm test`
- 构建:`npm run build`
- 代码检查:`npm run lint`

## 代码风格
- [仅包含非显而易见的约定]

## 架构
- [仅在复杂时简要说明]

## 重要事项
- [关键警告 - 谨慎使用]

格式规则

  • 使用项目符号而非段落
  • 使用 Markdown 标题分隔模块(防止指令混淆)
  • 具体优于模糊:"2空格缩进"而非"正确格式化"
  • 对关键规则使用 重要/你必须(谨慎使用,否则会失效)

文件位置

位置 作用范围
~/.claude/CLAUDE.md 所有会话(用户偏好)
./CLAUDE.md 项目根目录(可通过 git 共享)
./subdir/CLAUDE.md 在子目录工作时加载
.claude/rules/*.md 作为项目记忆自动加载

优化检查清单

最终确定前:
- [ ] 是否少于 50 行?(理想目标)
- [ ] 每一行是否都解决了你实际遇到的问题?
- [ ] 是否与其他 CLAUDE.md 位置的内容没有冗余?
- [ ] 是否没有包含 Claude 默认遵循的指令?
- [ ] 是否通过观察 Claude 行为变化进行了测试?

维护

  • /init 为起点,然后大力精简
  • 每隔几周:"审阅此 CLAUDE.md 并建议删除内容"
  • 当 Claude 行为不当时:添加具体规则
  • 当 Claude 忽略规则时:文件过长,需精简其他内容

反模式

避免 原因
200+ 行的 CLAUDE.md 会被忽略
"编写整洁的代码" Claude 已知晓
跨文件重复规则 浪费 token,可能冲突
理论性担忧 仅针对实际问题添加
冗长的散文式解释 使用项目符号

示例:最小化有效 CLAUDE.md

# MyApp

使用 Expo 的 React Native 应用。后端为 Supabase。

## 命令
- `pnpm test` - 运行测试
- `pnpm ios` - 运行 iOS 模拟器

## 风格
- 优先使用 Zustand 而非 Context
- 使用 `clsx` 处理条件类

## 重要事项
- 切勿提交 .env 文件
- 认证逻辑仅位于 src/lib/auth.ts

约 15 行。涵盖 Claude 无法推断的内容。仅此而已。

21 次点击  ∙  0 人收藏  
登录后收藏  
0 条回复
关于 ·  帮助 ·  PING ·  隐私 ·  条款   
OA0 - Omni AI 0 一个探索 AI 的社区
沪ICP备2024103595号-2
耗时 88 ms
Developed with Cursor