CLAUDE.md 指南

編寫最佳的 CLAUDE.md

CLAUDE.md 是決定 Claude 如何理解你專案的唯一檔案。寫得好意味著更少的修正、更好的程式碼,以及真正瞭解工作內容的代理。

本指南將帶你瞭解 CLAUDE.md 檔案的每個部分,從技術棧宣告到代理特定提示。跟著步驟一步步建置你自己的檔案。

什麼是 CLAUDE.md

CLAUDE.md 是放在專案根目錄的 Markdown 檔案。當 Claude Code 啟動會話時,它會首先讀取這個檔案。檔案中的所有內容都會成為 Claude 的上下文:技術棧、檔案結構、團隊規範,以及你希望每個代理遵循的具體指令。

可以把它看作簡報文件。沒有它,Claude 只能猜測專案的組織方式。有了好的 CLAUDE.md,Claude 已經知道檔案在哪裡、該遵循什麼模式、該避免什麼。輸出品質的差異是顯著的。

在 CLAUDE.md 上投入 10 分鐘,可以省去數小時修正不符合專案模式的 AI 生成程式碼的時間。

來自數百個 Claude Code 專案的觀察

差的 vs. 好的 CLAUDE.md

CLAUDE.md 的結構和具體程度直接影響 Claude 在程式碼庫中的表現。

薄弱的 CLAUDE.md

  • 沒有具體內容的模糊指令,如「遵循最佳實踐」
  • 沒有檔案結構對映,Claude 只能猜測新程式碼的放置位置
  • 缺少編碼規範,每次會話的輸出風格不一致
  • 沒有列出建置或測試命令,導致建議無法執行

優秀的 CLAUDE.md

  • 帶版本號的明確技術棧:React 19、Vite 6、Zustand 5、Tailwind 4
  • 清晰的檔案對映,展示關鍵目錄及其用途
  • 命名模式、錯誤處理、樣式偏好已記錄在案
  • 建置、測試和開發命令可直接複製執行

6 個必備部分

結構良好的 CLAUDE.md 涵蓋這六個方面。每個部分都為 Claude 提供可立即使用的具體資訊。

技術棧宣告

明確列出你的框架、庫及其版本。包括包管理器、Node 版本和任何執行時要求。Claude 使用這些資訊生成相容的程式碼,無需猜測。

檔案結構對映

描述你的關鍵目錄以及每個目錄中存放的內容。元件、狀態管理、服務、API 路由、型別定義。每個資料夾附帶一行說明的簡短樹狀圖效果很好。

編碼規範

記錄你的命名模式(檔案用 camelCase,元件用 PascalCase)、錯誤處理方式、import 排序和專案特定規則。這確保 Claude 的輸出與現有程式碼保持一致。

建置和測試命令

包含你的 dev、build、test 和 lint 命令。當 Claude 需要驗證某些功能或建議腳本時,它會使用你專案期望的確切命令。

代理角色提示

如果你使用多個代理(QA、前端、後端、DevOps),新增一個描述每個角色應關注什麼的部分。這在 AgentsRoom 的多代理設定中特別有用。

禁止區域

告訴 Claude 不要做什麼。不要修改配置檔案,不要更改認證系統,不要重構資料庫層。明確的邊界防止代理做出不必要的改動。

4 步建置你的 CLAUDE.md

不需要一次寫完所有內容。從基礎開始,在發現 Claude 需要了解的資訊時逐步擴充套件。

1

審查你的專案

開啟 package.json,列出專案使用的所有框架、庫和工具。記錄版本號,檢查執行時要求(Node 版本、Python 版本、資料庫)。這將成為你的技術棧部分。

package.json + 執行時版本 + 資料庫

2

對映檔案樹

快速輸出 src 目錄的樹狀結構。識別頂層資料夾,為每個資料夾寫一行說明。重點關注元件、狀態管理、服務、型別定義和 API 路由的位置。

帶用途註釋的 src/ 樹狀圖

3

記錄規範

檢視現有程式碼,記錄其中的模式:檔案命名方式、錯誤處理方式、import 的組織方式、使用預設匯出還是命名匯出。將這些寫成簡短的規則。

命名、import、錯誤處理、匯出

4

新增代理專屬部分

如果你使用專業代理,為每個角色新增關注領域。前端代理應瞭解你的元件庫,DevOps 代理應瞭解你的部署流程,QA 代理應瞭解你的測試框架。

按角色劃分的關注領域 + 禁止區域

為什麼用 AgentsRoom 管理 CLAUDE.md

AgentsRoom 將 CLAUDE.md 作為核心概念建置,而非附加功能。

內建 CLAUDE.md 編輯器

在 AgentsRoom 內直接編輯 CLAUDE.md,支援語法高亮和實時儲存。無需切換到文字編輯器或 IDE。

按代理實時預覽

實時檢視每個代理如何解讀你的 CLAUDE.md。透過觀察終端輸出,驗證代理是否遵循你的規範並尊重禁止區域。

按專案獨立上下文

AgentsRoom 中的每個專案都有自己的 CLAUDE.md。切換專案時,每個代理自動載入該程式碼庫對應的上下文檔案。

代理角色整合

AgentsRoom 的 14 個代理角色與 CLAUDE.md 的部分直接對應。按角色定義關注領域和禁止區域,每個代理只獲取針對自己的指令。

Watch what your CLAUDE.md does to Claude Code token usage

CLAUDE.md is prepended to every Claude turn. A bloated CLAUDE.md silently inflates Claude Code token usage on every message. AgentsRoom puts a per-session token meter on each agent so you can see exactly how much your CLAUDE.md is costing you, with a live cache hit rate to confirm it stays cached.

See the Claude Code token usage tracker

CLAUDE.md 常見問題

CLAUDE.md 檔案應該放在哪裡?+
放在專案目錄的根目錄,緊挨著 package.json 或同等配置檔案。Claude Code 在該目錄啟動會話時會自動讀取它。你也可以在子目錄中放置巢狀的 CLAUDE.md 檔案來提供更具體的上下文。
CLAUDE.md 檔案應該多長?+
沒有嚴格限制,但建議 50 到 300 行。涵蓋核心內容:技術棧、檔案結構、規範和命令。太短會導致 Claude 缺乏上下文。太長則重要內容可能被噪音淹沒。
CLAUDE.md 適用於所有 Claude 模型嗎?+
是的。無論你選擇哪個模型(Opus、Sonnet 或 Haiku),Claude Code 都會讀取 CLAUDE.md。所有模型都能從明確的專案上下文中獲益,不過像 Opus 這樣的大模型能吸收和應用更詳細的指令。
應該將 CLAUDE.md 提交到版本控制嗎?+
如果是共享的專案指令,應該提交。你的團隊可以在所有開發者之間獲得一致的 AI 行為。對於個人偏好,AgentsRoom 支援自動 gitignore 的個人代理配置。
可以在多代理設定中使用 CLAUDE.md 嗎?+
當然可以。在 AgentsRoom 中,專案裡的每個代理都讀取同一個 CLAUDE.md。你可以新增角色特定的部分(例如 QA 代理的備註與前端代理的備註),讓每個專業代理獲得有針對性的指令。
多久應該更新一次 CLAUDE.md?+
每當專案結構或規範發生變化時就更新。新增了新框架?更新技術棧。改變了目錄結構?更新檔案對映。過時的 CLAUDE.md 會導致過時的建議。

開始編寫更好的 CLAUDE.md

下載 AgentsRoom,使用內建 CLAUDE.md 編輯器為你的代理提供所需的上下文。好的指令帶來好的程式碼。

免費下載 AgentsRoom

配套應用:隨時隨地監控你的 Agent

使用 Claude、Codex、Antigravity CLI 或其他 AI 提供商。

獲取擴充套件
Chrome Web Store

把 Bug 和需求直接傳送到您的公開待辦清單。

AgentsRoom 實際執行一瞥。

多專案管理
多供應商
多代理執行
實時狀態
檔案差異與提交
行動應用
實時預覽
代理團隊
瀏覽器自動化
Backlog 驅動開發
提示詞庫
技能庫
檢視所有功能