回到提示詞庫

替專案寫一份給 Agent 看的說明

新的對話不知道怎麼建置、測試,也不知道有哪些慣例:寫一份一個畫面內看完的說明。

什麼時候用 新專案開始時,或換了 Agent 工具之後

完成後會得到什麼

一份簡短的專案說明草稿(AGENTS.md 或 CLAUDE.md),確認後寫入。

開始之前

  • Agent 可以讀取整個專案

執行步驟

  1. 查看建置、測試和執行方式
  2. 找出和一般做法不同的慣例
  3. 記下容易踩到的坑
  4. 控制在一個畫面內

應交付的產出

  • 專案說明草稿

完成標準

  • 只寫從程式碼看不出來的內容
  • 寫下的指令都能執行
  • 一個畫面內
  • 寫入前經過你確認

複製給 Agent

以唯讀方式分析這個專案,寫一份給 Agent 看的簡短說明:怎麼安裝、建置、測試和執行,程式碼慣例裡和一般做法不同的地方,以及容易踩到的坑。只寫從程式碼看不出來、每次都用得上的內容,控制在一個畫面內。專案裡已經有說明檔的話,就針對原檔提出修改建議,不要另外再建一份。先給我看草稿,我確認後再寫入。寫完草稿就停下來。