跳至主要內容
📋 核心概念

CLAUDE.md 原則

撰寫有效的專案指引,讓 Claude Code 獲得幫助你成功的所需上下文。

什麼是 CLAUDE.md?

CLAUDE.md 檔案 位於你的專案根目錄,包含 Claude Code 在幫助你之前會閱讀的指示。 把它想像成專門為 Claude 撰寫的專案文檔。

# 專案結構
my-project/
├── CLAUDE.md ← 給 Claude 的指示
├── src/
├── tests/
└── package.json

核心區塊

📖

專案概述

這是什麼專案?做什麼用的?保持簡潔。

# 我的專案
使用 WebSocket 的即時聊天應用
🛠️

技術棧

框架、語言和主要依賴。

**技術棧:** Node.js + TypeScript + PostgreSQL
🎯

核心政策

Claude 應該如何工作?預設行為和規則。

## 核心政策
- 直接執行,不需要詢問許可
- 使用平行 agents 探索
- 提交前先測試
📁

目錄結構

幫助 Claude 理解東西在哪裡。

⚠️

規則與限制

Claude 絕不應該自動做的事情。

## 禁止行為
- 絕不未詢問就 git push
- 絕不直接修改 prod config

最佳實踐

明確具體

清晰的指示減少誤解

保持更新

過時的資訊比沒有資訊更糟

使用範例

展示而不只是說明

區分全域與本地

全域規則在 ~/.claude/,專案特定在 CLAUDE.md

深入學習

獲得撰寫有效 CLAUDE.md 檔案的範本、範例和進階模式。