CLAUDE.md(專案手冊)
放在專案根目錄,給 Claude Code / Cowork / Codex 讀的「專案指引」。每次啟動都優先讀。
用途
- 規範編碼慣例
- 列禁忌項
- 說明架構原則
- 提供常用指令參考
PAM 專案的範例(節選)
# PAM 績效考核管理系統 — AI 開發規格文件
## 技術架構
- 後端:C# / .NET 8 + Web API
- 前端:React 19 + TypeScript + Vite
- DB:MSSQL + EF Core
## 命名規範
- 資料表 / 欄位:PascalCase
- 主鍵一律 `Id`
- 布林:`Is` 開頭
## 禁忌
- ❌ 拼接 SQL(`"WHERE name = '" + n + "'"`)
- ❌ Controller 吞例外
- ❌ 各處重寫等第公式(一律呼叫 [[GradingService]])您 vault 也有一份
/Users/vincent/.../Vincent5588_Wiki/CLAUDE.md — 這是給未來 LLM agent 進來時讀的,告訴它如何依 Karpathy LLM Wiki 模式 維護 raw/ 與 wiki/。
最佳實踐
✅ 簡潔、列關鍵點,不寫小說 ✅ 架構變動時更新 ✅ 明確列禁忌項,比說「請小心」有效(詳見 反面案例提示) ✅ 帶 Context 說明「為什麼」,讓 Claude 有判斷依據處理 edge case ✅ 包含您的語言/格式偏好(如「繁中為主」「不用過度道歉」)
進階:拆解到子目錄
當 CLAUDE.md 變太長時,可拆到 .claude/rules/、.claude/commands/、.claude/skills/、.claude/agents/ —— 詳見 Claude Code 專案結構。
4 層生效機制(重要)
CLAUDE.md 不只是「專案根目錄那一份」,而是4 層疊加:
1. ~/.claude/CLAUDE.md ← 全域個人偏好
2. {project}/CLAUDE.md ← 本檔(專案層)
3. {subfolder}/CLAUDE.md ← 子目錄局部規則
4. # 對話 inline ← 臨時最高
→ 完整解說見 CLAUDE.md 4 層機制。
搭配 Rules Directory:規則太多時改用 .claude/rules/<name>.md 做條件式啟用,避免 CLAUDE.md 過度膨脹。
跟其他 LLM 的差別
| 工具 | 對應檔名 |
|---|---|
| Claude Code | CLAUDE.md |
| OpenAI Codex | AGENTS.md |
| Cursor | .cursorrules |
| Copilot | .github/copilot-instructions.md |
格式類似,但檔名不同。多 LLM 並用時可以做 symlink。
在 Karpathy LLM Wiki 中
CLAUDE.md 是 Layer 3「Schema / 持久記憶」——告訴 LLM 結構規則、命名慣例、要跑什麼工作流。
詳見 Karpathy LLM Wiki 模式 §2「三層架構」。
相關概念
強連結(原文明確提及)
- Claude Code
- Cowork
- CLAUDE.md 4 層機制 — 4 層疊加生效
- Rules Directory — 條件式規則啟用
- Claude Code 專案結構 — 完整 .claude/ 6 大目錄
- 反面案例提示 — 寫法技巧
- Slash Commands —
/init自動產生 CLAUDE.md 初版 - Boris Cherny 13 條心法 — Boris 第 3 條:團隊共享 CLAUDE.md 飛輪
推斷連結(LLM 認為相關,待確認)
深入閱讀(外部資源)
← 回到 wiki