summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorHerobrine <45513138+herobrine19@users.noreply.github.com>2026-04-19 01:51:03 +0800
committerGitHub <noreply@github.com>2026-04-19 01:51:03 +0800
commitfcd5d36cd2d2e31ef3342d95d7ac073525e460e2 (patch)
tree4dbc8b298a07391a207b7eef6cb30296d25faaaa
parentc9a44ae835fa2f5765a697216692705761a53f40 (diff)
Add Chinese translation for README (#93)
- Add README.zh.md with full Chinese translation - Add language switcher link in original README.md
-rw-r--r--README.md2
-rw-r--r--README.zh.md167
2 files changed, 169 insertions, 0 deletions
diff --git a/README.md b/README.md
index 2a9cc9d..a602ecb 100644
--- a/README.md
+++ b/README.md
@@ -6,6 +6,8 @@
A single `CLAUDE.md` file to improve Claude Code behavior, derived from [Andrej Karpathy's observations](https://x.com/karpathy/status/2015883857489522876) on LLM coding pitfalls.
+English | [简体中文](./README.zh.md)
+
## The Problems
From Andrej's post:
diff --git a/README.zh.md b/README.zh.md
new file mode 100644
index 0000000..523d191
--- /dev/null
+++ b/README.zh.md
@@ -0,0 +1,167 @@
+# 受 Karpathy 启发的 Claude Code 指南
+
+> 查看我的新项目 [Multica](https://github.com/multica-ai/multica) —— 一个用于运行和管理编码智能体的开源平台,支持可复用的技能。
+>
+> 在 X 上关注我:[https://x.com/jiayuan_jy](https://x.com/jiayuan_jy)
+
+一个单一的 `CLAUDE.md` 文件,用于改善 Claude Code 的行为,源自 [Andrej Karpathy 的观察](https://x.com/karpathy/status/2015883857489522876) 关于 LLM 编码陷阱的总结。
+
+[English](./README.md) | 简体中文
+
+## 问题所在
+
+来自 Andrej 的推文:
+
+> "模型会代你做错误假设,然后不假思索地执行。它们不管理自身的困惑,不寻求澄清,不呈现矛盾,不展示权衡,在应该提出异议时也不反驳。"
+
+> "它们真的很喜欢把代码和 API 搞复杂,堆砌抽象概念,不清理死代码……明明 100 行能搞定的事情,非要实现成 1000 行的臃肿架构。"
+
+> "它们有时仍会改动或删除自己理解不足的代码和注释,即使这些内容与任务本身无关。"
+
+## 解决方案
+
+四个原则,集中在一个文件中,直接解决这些问题:
+
+| 原则 | 解决什么问题 |
+|-----------|-----------|
+| **编码前思考** | 错误假设、隐藏困惑、缺少权衡 |
+| **简洁优先** | 过度复杂、臃肿抽象 |
+| **精准修改** | 无关编辑、触碰不应碰的代码 |
+| **目标驱动执行** | 通过测试优先、可验证的成功标准 |
+
+## 四个原则详解
+
+### 1. 编码前思考
+
+**不要假设。不要隐藏困惑。呈现权衡。**
+
+LLM 经常默默选择一种解释然后执行。这个原则强制明确推理:
+
+- **明确说明假设** — 如果不确定,询问而不是猜测
+- **呈现多种解释** — 当存在歧义时,不要默默选择
+- **适时提出异议** — 如果存在更简单的方法,说出来
+- **困惑时停下来** — 指出不清楚的地方并要求澄清
+
+### 2. 简洁优先
+
+**用最少的代码解决问题。不要过度推测。**
+
+对抗过度工程的倾向:
+
+- 不要添加要求之外的功能
+- 不要为一次性代码创建抽象
+- 不要添加未要求的"灵活性"或"可配置性"
+- 不要为不可能发生的场景做错误处理
+- 如果 200 行代码可以写成 50 行,重写它
+
+**检验标准:** 资深工程师会觉得这过于复杂吗?如果是,简化。
+
+### 3. 精准修改
+
+**只碰必须碰的。只清理自己造成的混乱。**
+
+编辑现有代码时:
+
+- 不要"改进"相邻的代码、注释或格式
+- 不要重构没坏的东西
+- 匹配现有风格,即使你更倾向于不同的写法
+- 如果注意到无关的死代码,提一下 —— 不要删除它
+
+当你的改动产生孤儿代码时:
+
+- 删除因你的改动而变得无用的导入/变量/函数
+- 不要删除预先存在的死代码,除非被要求
+
+**检验标准:** 每一行修改都应该能直接追溯到用户的请求。
+
+### 4. 目标驱动执行
+
+**定义成功标准。循环验证直到达成。**
+
+将指令式任务转化为可验证的目标:
+
+| 不要这样做... | 转化为... |
+|--------------|-----------------|
+| "添加验证" | "为无效输入编写测试,然后让它们通过" |
+| "修复 bug" | "编写重现 bug 的测试,然后让它通过" |
+| "重构 X" | "确保重构前后测试都能通过" |
+
+对于多步骤任务,说明一个简短的计划:
+
+```
+1. [步骤] → 验证: [检查]
+2. [步骤] → 验证: [检查]
+3. [步骤] → 验证: [检查]
+```
+
+强有力的成功标准让 LLM 能够独立循环执行。弱标准("让它工作")需要不断澄清。
+
+## 安装
+
+**选项 A:Claude Code 插件(推荐)**
+
+在 Claude Code 中,首先添加插件市场:
+```
+/plugin marketplace add forrestchang/andrej-karpathy-skills
+```
+
+然后安装插件:
+```
+/plugin install andrej-karpathy-skills@karpathy-skills
+```
+
+这会将指南安装为 Claude Code 插件,使其在你所有项目中可用。
+
+**选项 B:CLAUDE.md(按项目)**
+
+新项目:
+```bash
+curl -o CLAUDE.md https://raw.githubusercontent.com/forrestchang/andrej-karpathy-skills/main/CLAUDE.md
+```
+
+已有项目(追加):
+```bash
+echo "" >> CLAUDE.md
+curl https://raw.githubusercontent.com/forrestchang/andrej-karpathy-skills/main/CLAUDE.md >> CLAUDE.md
+```
+
+## 核心洞察
+
+来自 Andrej:
+
+> "LLM 非常擅长循环执行直到达成特定目标……不要告诉它该做什么,给它成功标准,然后看着它完成。"
+
+"目标驱动执行"原则正是捕捉了这一点:将指令式指令转化为带有验证循环的声明式目标。
+
+## 如何判断它在起作用
+
+如果你看到以下情况,说明这些指南正在发挥作用:
+
+- **diff 中不必要的改动更少** —— 只有请求的改动出现
+- **因过度复杂而导致的重写更少** —— 代码第一次就写得简洁
+- **澄清问题在实现之前提出** —— 而不是在犯错之后
+- **干净、精简的 PR** —— 没有顺带的重构或"改进"
+
+## 定制
+
+这些指南设计用于与项目特定指令合并。将它们添加到你现有的 `CLAUDE.md` 或创建一个新的。
+
+对于项目特定规则,添加如下章节:
+
+```markdown
+## 项目特定指南
+
+- 使用 TypeScript 严格模式
+- 所有 API 端点必须有测试
+- 遵循 `src/utils/errors.ts` 中现有的错误处理模式
+```
+
+## 权衡说明
+
+这些指南倾向于**谨慎而非速度**。对于琐碎的任务(简单的拼写错误修复、显而易见的一行修改),请自行判断 —— 并非每个改动都需要完整的严谨流程。
+
+目标是减少非琐碎工作中的代价高昂的错误,而不是拖慢简单任务。
+
+## 许可
+
+MIT