幫目前專案寫一份上手指南
自己找入口和主流程,留下新人能用的導覽。本站編寫 · 附 Claude Code 官方參考資料 · 來源核對日期:
參考依據與借鏡內容
- 常見工作流程:理解新專案
參考官方專案導覽工作流程;自動選主流程、檔案上限和完整指南交付為本站設計。
請為目前專案寫一份新人上手指南,讀者有基本開發經驗,但從沒接觸過這個儲存庫。 先看目錄、README 和專案設定,自動辨識應用程式入口及主要職責。只選擇一條最有代表性的現有功能:優先選 README 強調的核心功能,沒有則選擇能從入口明確追蹤的流程。用一句話說明選擇理由,不讓我挑模組。 沿這條流程追蹤輸入、處理、狀態或儲存、輸出,重點閱讀最多 10 個原始碼檔案。輸出簡潔的模組關係圖或文字流程、關鍵檔案路徑、每一層負責什麼,以及 3 個常見修改應該從哪裡著手。 執行和檢查指令必須來自專案現有設定,只列出不執行。對只能推斷的連接註明推斷依據,不用框架常識填補沒讀過的程式碼。 完成標準:交付一份結構完整的 Markdown 指南,實際路徑核對存在;清楚區分已讀內容與未涵蓋部分,避免只有目錄樹而沒有功能解釋。 執行約定: 直接開始,不先給計畫讓我確認,也不要讓我選檔案或補填範本。只用目前專案、目前對話及我已提供的材料,不搜尋其他專案或私人歷史。缺少材料時完成有依據的部分,在結果中說明缺口;完全不適用就說明原因並結束,不虛構成果。 保留現有檔案和未提交的改動;候選內容在回覆中完整給出,適合獨立成文的成果可另存為不重複檔名的新檔案。不要安裝相依套件、修改環境、提交、推送或發布。遇到權限或存取限制,記錄未完成項目,不繞過限制。自我檢查一次後交付並結束,不用「是否繼續」收尾。