完成後會得到什麼
一份以實際檔案為依據的新人導覽。
開始之前
- 允許建立一個文件檔
執行步驟
- 找出建置和執行的進入點
- 追蹤一個具代表性的請求
- 說明資料和權限的邊界
- 列出安全的修改點和危險的捷徑
應交付的產出
- 架構圖
- 重要檔案索引
- 第一次修改的建議
完成標準
- 每一節都連到實際檔案
- 清楚說明哪些地方不該直接改
複製給 Agent
幫新人寫一份程式碼導覽。追蹤執行進入點、一條端到端流程、資料邊界、設定、測試與部署;引用實際檔案,列出適合第一次修改的地方、危險的捷徑和還不清楚的部分。先給我看大綱,核准後只建立一個文件檔。