功能追蹤導航器(使用者操作 → 呼叫圖 → 程式碼導覽)
從 UI 或 API 入口追蹤單一功能,經由控制器、服務與資料層,產生呼叫圖並附加註解導覽。
提示詞概覽
給你的提示
- 提供日誌或測試名稱以精確定位實際執行路徑。 - 包含錯誤處理程式碼以捕捉替代流程。 - 附上生產環境使用的簡短範例請求體。
來自營運團隊NexusAi Technology解決的問題
跨層追蹤完整功能路徑容易出錯。本工具產生可靠的呼叫圖並指出下一步探查重點。
端對端路徑清晰
精確顯示資料如何穿越各層。
可行註解
每一步驟包含目的、輸入/輸出與副作用。
測試缺口偵測
突顯路徑中缺失或薄弱的測試。
下一步檔案指引
告訴你下一個該讀取的檔案及原因。
AI 提示詞指令
扮演資深全端工程師與程式碼地圖製作者。
此任務的重要性:
端對端追蹤揭示資料流向、副作用位置,以及維護與測試的關鍵元件。
重要限制:
- 僅使用提供的路由、控制器、服務與模型程式碼片段。
- 若有多種變體,優先考慮生產環境路徑。
使用者輸入:
- 功能描述(例如「建立任務」透過 POST /tasks)。
- 相關檔案:路由處理器、控制器、服務、模型、中介軟體。
- 涵蓋此路徑的任何日誌或測試名稱。
目標:
1) 從入口到資料持久化產生清晰的呼叫圖。
2) 為關鍵函式註解目的、輸入/輸出與副作用。
3) 識別風險、缺失測試與可觀察性缺口。
4) 建議下一步閱讀檔案順序。
分析流程:
1) 從路由開始,定位控制器與服務呼叫。
2) 追蹤資料轉換與驗證。
3) 記錄外部呼叫(資料庫、佇列、HTTP)與錯誤處理。
4) 交叉參考現有測試。
5) 總結效能、可靠性與可讀性問題。
所需輸出格式:
- 文字呼叫圖(縮排清單)方便複製貼上。
- 每步驟註解:目的、參數、輸出、副作用。
- 缺失測試與建議測試案例。
- 下一步建議檔案(5 個)。
品質控管:
- 包含精確函式名稱與檔案路徑。
- 區分斷言與推測,推測需明確標示。
驗證清單:
- 涵蓋所有層級(路由 → 控制器 → 服務 → 模型)。
- 識別外部整合。
最終指示:
交付一份新工程師能依循,並自信實作錯誤修正的追蹤報告。
預期成果
呼叫圖: POST /tasks → routes/tasks.js:createTask → controllers/taskController.js:create → services/taskService.js:createTask → models/task.js:Task.create 註解: - createTask(路由):驗證請求體結構;轉交控制器 - controller.create:映射 DTO,處理 try/catch - service.createTask:執行商業規則,去除重複標題 - Task.create:持久化並回傳 id 缺失測試:重複標題拒絕;無效請求體回傳 400。 下一步檔案:middleware/validateBody.js, services/notifications.js
實施流程
使用 Codex 建立追蹤
開啟 Codex。貼上所選功能的路由、控制器、服務與模型程式碼片段。使用此提示要求產生呼叫圖與附註導覽。預期得到分層追蹤,包含函式名稱與路徑。
12 min在 VS Code 驗證呼叫
跳轉至 VS Code 中的每個函式,確認參數、回傳值與副作用。新增或修正缺失步驟(佇列、快取、HTTP 呼叫)。
10 min轉換為測試清單
將缺失測試清單轉為測試執行器中的測試名稱並建立佔位。將追蹤與清單分享於版本庫文件,引導下一次 PR。
8 min
