註冊

CLAUDE.md 怎麼寫：讓 Claude Code 讀完倉庫生成項目 CLAUDE.md / AGENTS.md 提示詞

在項目裏開始用 Claude Code（或 Codex 等編程智能體）時用：讓它先讀倉庫裏的配置、腳本和 CI，再生成一份精簡的項目說明文件，只寫智能體無法自己推斷、但每次都要遵守的內容（常用命令、架構要點、團隊約定、禁區），並提醒哪些規則應該改用鉤子強制執行。

NNathaniel bigo··原創首發·AI 輔助撰寫
Claude 對話模型通用
請為當前倉庫編寫一份給編程智能體看的項目說明文件：[CLAUDE.md/AGENTS.md/兩者都要]。這份文件會在每次會話開始時被讀入上下文，所以每一行都要有用。

補充背景（倉庫裏看不出來的資訊）：
- 項目用途與使用者：[項目用途]
- 團隊約定（分支、提交資訊格式、代碼審查要求等）：[團隊約定]
- 過去智能體犯過的錯或容易踩的坑：[踩過的坑]
- 絕對不能做的操作：[禁止操作]

工作步驟：
1. 先調查，不要急着寫。閱讀並總結：README 與 docs 目錄、依賴清單與鎖文件、package.json scripts / Makefile / justfile 等任務腳本、CI 配置、lint 與格式化配置、測試配置、目錄結構、已有的 CLAUDE.md 或 AGENTS.md。
2. 把你的發現列成清單給我確認，特別是：構建、測試、單個測試文件的運行方式、lint 命令；以及你從代碼中推斷出來、但不確定的約定。等我確認後再寫文件。
3. 文件內容只包含這幾類：
   - 項目一句話概述與技術棧；
   - 常用命令（每條一行，註明用途；運行單個測試的方式要單獨寫出）；
   - 架構地圖：關鍵目錄與模組的職責，數據或請求的主要流向；
   - 不能從 linter 和代碼裏直接看出的約定，例如「金額一律用整數分」「新接口必須經過某個鑑權中間件」；
   - 已知的坑與禁區，每條寫清原因；
   - 完成任務的標準，例如「提交前必須跑通測試和類型檢查」。
4. 不要寫：通用編程常識（如「寫清晰的代碼」）、可以直接從代碼推斷的資訊、會很快過時的細節（具體行號、臨時任務）、任何密鑰或內部地址。
5. 篇幅控制在 200 行以內。只在某個子目錄才需要的規則，建議放到該子目錄自己的說明文件中，不要堆在根目錄。
6. 如果倉庫已有說明文件，在原文件基礎上提出修改建議並標註增刪，不要整體覆蓋。

最後另外列出：
- 哪些規則屬於「必須百分之百執行」的（如禁止修改某個目錄、提交前必須格式化），這類規則寫在說明文件裏只是提示，建議改為鉤子或 CI 檢查來強制執行，並說明怎麼做；
- 只能由我補充的資訊清單。

高亮處換成你自己的內容：[項目用途]、[團隊約定]、[踩過的坑]、[禁止操作]

Claude Pro 充值

已被複製 0 次

Claude編程開發

使用說明

怎麼用：在項目根目錄打開 Claude Code，直接粘貼這段提示詞（[踩過的坑] 這類資訊只有你知道，盡量填寫）。Claude Code 自帶的 /init 也能生成初稿；這條提示詞的區別是先調查、再確認、最後才寫，並嚴格控制篇幅。

幾個事實（據 Claude Code 官方文檔，2026-10 核對）：

  • 項目級 CLAUDE.md 放在倉庫根目錄或 .claude/ 下；個人偏好放在不提交的 CLAUDE.local.md 或 ~/.claude/CLAUDE.md。
  • CLAUDE.md 可以用 @路徑 導入其他文件；官方建議每個文件 200 行以內。
  • 倉庫已有 AGENTS.md（Codex 等工具使用）且沒有 CLAUDE.md 時，新版 Claude Code 會直接讀取 AGENTS.md；兩者都有時預設只讀 CLAUDE.md，可以在 CLAUDE.md 裏寫一行 @AGENTS.md 共用一份內容。
  • 說明文件是「上下文」而不是強制配置，必須攔住的操作要用鉤子（hooks）。

追問技巧：用一段時間後，把智能體又犯的錯告訴它：「把這次的教訓用一行寫進 CLAUDE.md 的『已知的坑』，並檢查有沒有可以刪掉的過時條目」。

示例輸出

示例，僅供參考（節選）
markdown
# 訂單服務

Node.js 22 + Fastify + Prisma（PostgreSQL）。對外提供下單、支付回調、退款接口。

## 常用命令
- pnpm dev：本地啟動（需先 docker compose up -d db）
- pnpm test：全部測試；單個文件用 pnpm vitest run src/orders/refund.test.ts
- pnpm lint && pnpm typecheck：提交前必須通過

## 約定
- 金額一律用整數「分」存儲與計算，不用浮點數
- 支付回調必須先驗籤再處理，驗籤邏輯只在 src/payments/verify.ts

## 已知的坑
- 修改 prisma/schema.prisma 後要運行 pnpm prisma generate，否則類型不會更新

同款作品

用這條提示詞做出來的作品；原作者會因此獲得積分

做同款

還沒有同款，來做第一個。

Nathaniel 的更多內容

職場辦公

採購申請 / 費用申請怎麼寫提示詞（申請理由、預算明細、比價、預期收益，審批一次通過）

【角色】你是一名經常幫同事寫審批材料的部門助理，知道審批人看申請時最關心三件事：必要性、金額是否合理、有沒有更便宜的辦法。 【背景】 - 申請類型：[如裝置採購/軟件訂閱/外包服務/培訓費用] - 申請事項與規格：[申請事項] - 用途與使用人：[用途與使用人] - 為什麼現在需要（現狀問題、業務需求）：[申請理由]

通用大模型0
資訊圖提示詞：古人發朋友圈，穿越風手機介面整活圖（宋朝示例，可換任意朝代人物）AI 生成

資訊圖提示詞：古人發朋友圈，穿越風手機介面整活圖（宋朝示例，可換任意朝代人物）

GPT-Image-21
產品與設計

MVP 範圍界定提示詞（核心假設、必須做 / 可以做 / 不做清單、最小可驗證版本與成功標準）

身份：創業公司的產品負責人，做過多個從 0 到 1 的產品。你的看法：MVP 不是「功能少一點的完整產品」，而是「為了驗證一個最關鍵的假設，所能做的最小的東西」；有時候一個落地頁、一次人工服務就夠了。 產品想法：[產品想法] 目標用戶與他們的問題：[用戶與問題] 我們相信的價值主張：[價值主張] 完整版設想的功能清單：

通用大模型0
圖生影片

seedance 提示詞：光學變焦運鏡教學（江南雨後古巷 · 兩人重逢 · 固定機位只靠變焦講故事）

【全局設定】古風寫實電影鏡頭，東方古典生活敘事，雨後的[江南古鎮]：青石台階、青磚黛瓦、木廊、雕花木門、竹簾、溼漉漉的石巷。陰天柔和的漫射光，低反差，冷灰綠與暖木色交融，輕微 35mm 膠片顆粒，真實的皮膚、木、石、布料質感，電影淺景深，16:9，約 13 秒。 女主 A：@圖片1；女主 B：@圖片2。全程嚴格保持人物

Seedance1
編程開發

消息隊列方案設計提示詞（Kafka / RabbitMQ / RocketMQ 選型、消息不丟、順序消費、重複消費）

你是一名精通消息中間件的後端架構師。請為下面的場景設計消息隊列方案。 場景： - 業務用途：[如訂單支付後通知積分、物流、短訊三個系統] - 消息量：[消息量]（例：平時每秒 200 條，峰值每秒 5000 條） - 對可靠性的要求：[如絕對不能丟、偶爾重複可以接受] - 是否需要順序：[如同一訂單的狀態變更必須按順序

通用大模型0
ai穿搭提示詞：上載全身照生成潑墨塗鴉風套裝三視圖設計稿，正側背同一人（gpt-image-2）AI 生成

ai穿搭提示詞：上載全身照生成潑墨塗鴉風套裝三視圖設計稿，正側背同一人（gpt-image-2）

GPT-Image-20

同主題

編程開發

Python 類型註解提示詞：給老代碼補類型註解 + 修復 mypy / pyright 報錯（不靠 Any 糊過去）

你是一名精通 Python 類型系統的工程師。請幫我處理類型註解。 - Python 版本：[如 3.12] - 類型檢查工具與嚴格程度：[類型檢查工具與嚴格程度]（例：mypy --strict、pyright basic） - 任務：[給代碼補註解/修復報錯/兩者都要] - 代碼： [粘貼代碼] - 類型檢查器的報

通用大模型0
編程開發

設計模式怎麼用提示詞：按代碼場景推薦合適的設計模式（含不該用的情況和改造前後對比）

你是一名務實的資深工程師。你認為設計模式是解決特定問題的工具，而不是代碼質素的標誌；能用簡單函數解決的，就不要引入類層次結構。 - 語言：[語言]（例：Python、Java、TypeScript） - 代碼： [粘貼代碼] - 讓我難受的地方：[如每加一種支付方式都要改五處] - 預計未來的變化：[如半年內還要接入

通用大模型0
編程開發

前端頁面組件怎麼拆提示詞（組件樹設計、狀態放在哪一層、Props 接口、可複用組件識別）

你是一名擅長組件設計的前端架構師。請在寫代碼之前，先幫我設計頁面的組件結構。 - 框架：[框架]（例：React、Vue 3） - 頁面描述（區塊、交互、數據來源；有原型可描述原型）： [頁面描述] - 已有的通用組件庫：[已有組件庫]（例：Ant Design + 團隊內部組件） - 狀態管理方案：[狀態管理]（例：

通用大模型0
編程開發

SQL 方言轉換提示詞（MySQL、PostgreSQL、Oracle、SQL Server、Hive / Spark SQL 互轉，標出語義差異）

請把下面的 SQL 從源數據庫轉換為目標數據庫。你是一名同時熟悉這兩種數據庫的數據工程師，最關心的是轉換後結果是否和原來完全一致。 - 源數據庫及版本：[如 MySQL 5.7] - 目標數據庫及版本：[如 PostgreSQL 16] - 待轉換的 SQL（可以是查詢、建表語句、存儲過程）： [粘貼 SQL] - 涉

通用大模型0
編程開發

TypeScript 類型報錯怎麼解決提示詞（逐條翻譯報錯訊息 + 不用 any 和斷言的正確修法）

你是一名精通 TypeScript 類型系統的前端工程師。請幫我解決下面的類型報錯。 - TypeScript 版本與關鍵編譯選項：[如 5.6，strict 開啟] - 框架與相關庫：[框架與相關庫]（例：React 19、Vue 3、Node.js） - 報錯訊息（完整粘貼，包括錯誤碼和多行的詳細說明）： [粘貼報

通用大模型0
編程開發

Nginx 配置怎麼寫提示詞（反向代理、HTTPS 證書、WebSocket、上載文件大小、gzip、前端單頁應用路由）

你是一名運維工程師，熟悉 Nginx 的配置和排錯。請幫我編寫或修改 Nginx 配置。 - 部署結構：[部署結構]（例：前端靜態文件 + 後端 Node 服務在 3000 端口） - 域名與 HTTPS：[域名與證書]（例：已有證書文件，需要 HTTP 跳轉 HTTPS） - 需要支持的功能：[功能]（例：WebSo

通用大模型0

同模型

職場辦公

Claude 讀長文檔提示詞（文檔放最前、問題放最後，先摘錄原文引用再回答，減少看漏和編造）

<document> <source>[文檔名稱與日期]</source> <document_content> [粘貼長文檔全文] </document_content> </document> 以上是我要你閱讀的文檔。我是 [我的身份]，讀這份文檔是為了 [閱讀目的]。 請回答下面的問題： [我的問題清單] 回答方

Claude0
編程開發

Claude API 預填充（prefill）不能用了怎麼辦：替代寫法改造提示詞（結構化輸出、直接指令、XML 標籤、續寫）

我的代碼在調用 Claude API 時使用了預填充（在 messages 最後放一條 assistant 消息，讓模型接着寫）。升級模型後需要去掉這種用法。請幫我逐處改造。 <code> [粘貼調用代碼] </code> 目標模型：[目標模型] 使用的 SDK 與語言：[SDK 與語言] 下游怎麼用返回結果：[下游如

Claude0
職場辦公

Claude Projects 項目指令怎麼寫：項目自定義指令模板提示詞（讓 Claude 先採訪你，再生成可粘貼的指令）

我在 Claude 裏新建了一個項目，想寫一份項目指令（Project instructions），讓這個項目裏的每個對話都按同一套要求工作。請你幫我起草。 項目是做什麼的：[項目用途] 我會放進項目知識庫的資料：[知識庫資料清單] 常讓你做的幾類事：[常見任務] 第一步：採訪我 先向我提 6–8 個問題，一次問完，等

Claude0
文案寫作

Claude 回答格式控制提示詞（少用列表和加粗、寫成連貫段落；按官方四種方法調輸出格式）

<writing_format> 這份內容的讀者是 [讀者是誰]，他們會在 [閱讀場景] 裏閱讀，所以請按下面的方式組織文字。 預設寫法：用完整的句子和自然銜接的段落來寫，每段圍繞一個意思展開，段與段之間靠過渡句連接，像一篇認真寫的文章或一封寫給同事的信。 結構元素的使用範圍： - 小標題：只在全文超過 [多少字以上]

Claude0
文案寫作

Claude 模仿文風提示詞（3–5 篇樣文放進 example 標籤，先提煉風格卡給你確認，再按風格寫新稿）

我想讓你學習一種寫作風格，然後用這種風格寫一篇新內容。樣文都是 [樣文作者說明] 寫的。 <examples> <example> [樣文一] </example> <example> [樣文二] </example> <example> [樣文三] </example> </examples> 第一步：提煉風格卡（先

Claude0
職場辦公

Claude 多文檔交叉核對提示詞（documents 標籤裝多份資料，找出一致、矛盾和各自獨有的資訊並標明出處）

<documents> <document index="1"> <source>[資料一名稱與日期]</source> <document_content> [資料一內容] </document_content> </document> <document index="2"> <source>[資料二名稱與日期]<

Claude0

0 條評論

登入 後參與評論

還沒有評論，來搶沙發～