Spaces:
Sleeping
Sleeping
Commit
·
bf4f8fc
1
Parent(s):
ef0c5ea
docs: enhance LLM execution guidelines to prevent common pitfalls and improve task efficiency
Browse files- .github/copilot-instructions.md +5 -5
- .github/prompts/project.report.prompt.md +1 -1
- change-log.md +0 -35
.github/copilot-instructions.md
CHANGED
|
@@ -27,7 +27,7 @@
|
|
| 27 |
|
| 28 |
其他重要檔案:
|
| 29 |
- **`spec/plan.md`**(短期):本次迭代的範圍、目標、驗收標準。臨時討論檔,每個 sprint 更新後可拋棄。
|
| 30 |
-
- **`
|
| 31 |
|
| 32 |
## 核心守則(3 點)
|
| 33 |
|
|
@@ -85,7 +85,7 @@ commit 前確認以下兩點:
|
|
| 85 |
|
| 86 |
- 每次開始新迭代時,在 `spec/plan.md` 討論本次目標、範圍、驗收標準。
|
| 87 |
- 根據 plan.md 的內容,可在 `spec/task.md` 維護任務拆解(子任務應小而可驗收)。
|
| 88 |
-
- 迭代完成後,更新 `
|
| 89 |
- 舊的 `plan.md` 和 `task.md` 可拋棄,下次迭代時重新建立。
|
| 90 |
- **長期的規格變更和決策應同步回對應的 spec 模塊文件**(`00-overview.md` / `01-data-contract.md` / `02-processing-rules.md` / `03-error-handling.md` / `04-extensions.md`),形成累積的設計參考。
|
| 91 |
|
|
@@ -118,7 +118,7 @@ commit 前確認以下兩點:
|
|
| 118 |
- ✅ **只做**:
|
| 119 |
1. 掃描現有程式碼結構
|
| 120 |
2. 建立 5 份規格 + 2 份計畫檔案
|
| 121 |
-
3. 更新 `
|
| 122 |
4. 直接結束,不進行任何驗證
|
| 123 |
- **流程**:
|
| 124 |
1. LLM 掃描現有程式碼結構,分析核心模組與資料流。
|
|
@@ -139,7 +139,7 @@ commit 前確認以下兩點:
|
|
| 139 |
- **流程**:
|
| 140 |
1. 基於 plan.md 的目標,讀取對應的 spec 模塊(如「新增 CSV 欄位」→ `01-data-contract.md` + `04-extensions.md`)。
|
| 141 |
2. 產出編號任務清單與驗收標準。
|
| 142 |
-
3. 逐個實作任務,完成後更新 `
|
| 143 |
4. 下次迭代時,舊 plan.md 可拋棄,根據新需求重新開始。
|
| 144 |
|
| 145 |
### 標準工作流
|
|
@@ -151,7 +151,7 @@ commit 前確認以下兩點:
|
|
| 151 |
|
| 152 |
**執行迭代時:**
|
| 153 |
4. 執行 `/project.plan` 根據 plan.md 拆解任務 → 讀取對應 spec 模塊。
|
| 154 |
-
5. 根據任務清單實作,完成後更新 `
|
| 155 |
6. 迭代結束,舊的 plan.md 與 task.md 可拋棄。
|
| 156 |
|
| 157 |
**下次需求改變時:** 回到步驟 1。
|
|
|
|
| 27 |
|
| 28 |
其他重要檔案:
|
| 29 |
- **`spec/plan.md`**(短期):本次迭代的範圍、目標、驗收標準。臨時討論檔,每個 sprint 更新後可拋棄。
|
| 30 |
+
- **`changelog.md`**:記錄完成的變更摘要(高層描述,非逐行對應)。用於交付追蹤。
|
| 31 |
|
| 32 |
## 核心守則(3 點)
|
| 33 |
|
|
|
|
| 85 |
|
| 86 |
- 每次開始新迭代時,在 `spec/plan.md` 討論本次目標、範圍、驗收標準。
|
| 87 |
- 根據 plan.md 的內容,可在 `spec/task.md` 維護任務拆解(子任務應小而可驗收)。
|
| 88 |
+
- 迭代完成後,更新 `changelog.md` 記錄變更摘要。
|
| 89 |
- 舊的 `plan.md` 和 `task.md` 可拋棄,下次迭代時重新建立。
|
| 90 |
- **長期的規格變更和決策應同步回對應的 spec 模塊文件**(`00-overview.md` / `01-data-contract.md` / `02-processing-rules.md` / `03-error-handling.md` / `04-extensions.md`),形成累積的設計參考。
|
| 91 |
|
|
|
|
| 118 |
- ✅ **只做**:
|
| 119 |
1. 掃描現有程式碼結構
|
| 120 |
2. 建立 5 份規格 + 2 份計畫檔案
|
| 121 |
+
3. 更新 `changelog.md`
|
| 122 |
4. 直接結束,不進行任何驗證
|
| 123 |
- **流程**:
|
| 124 |
1. LLM 掃描現有程式碼結構,分析核心模組與資料流。
|
|
|
|
| 139 |
- **流程**:
|
| 140 |
1. 基於 plan.md 的目標,讀取對應的 spec 模塊(如「新增 CSV 欄位」→ `01-data-contract.md` + `04-extensions.md`)。
|
| 141 |
2. 產出編號任務清單與驗收標準。
|
| 142 |
+
3. 逐個實作任務,完成後更新 `changelog.md`。
|
| 143 |
4. 下次迭代時,舊 plan.md 可拋棄,根據新需求重新開始。
|
| 144 |
|
| 145 |
### 標準工作流
|
|
|
|
| 151 |
|
| 152 |
**執行迭代時:**
|
| 153 |
4. 執行 `/project.plan` 根據 plan.md 拆解任務 → 讀取對應 spec 模塊。
|
| 154 |
+
5. 根據任務清單實作,完成後更新 `changelog.md`。
|
| 155 |
6. 迭代結束,舊的 plan.md 與 task.md 可拋棄。
|
| 156 |
|
| 157 |
**下次需求改變時:** 回到步驟 1。
|
.github/prompts/project.report.prompt.md
CHANGED
|
@@ -13,6 +13,6 @@
|
|
| 13 |
- **後續建議**:風險、後續工作、優化空間
|
| 14 |
|
| 15 |
守則
|
| 16 |
-
- 不做檔案修改;由使用者根據報告內容手動更新 `
|
| 17 |
- 若有 UX 變更,明確提示使用者需要更新 README 的具體章節與內容。
|
| 18 |
- 完成後提示使用者本次 sprint 交付狀態與下一步建議。
|
|
|
|
| 13 |
- **後續建議**:風險、後續工作、優化空間
|
| 14 |
|
| 15 |
守則
|
| 16 |
+
- 不做檔案修改;由使用者根據報告內容手動更新 `changelog.md` 與 `README.md`。
|
| 17 |
- 若有 UX 變更,明確提示使用者需要更新 README 的具體章節與內容。
|
| 18 |
- 完成後提示使用者本次 sprint 交付狀態與下一步建議。
|
change-log.md
DELETED
|
@@ -1,35 +0,0 @@
|
|
| 1 |
-
# 變更記錄 (Change Log)
|
| 2 |
-
|
| 3 |
-
**專案**:TTSAM(Taiwan Transformer-based Shake Alert Model)
|
| 4 |
-
**格式**:高層變更摘要,按日期倒序排列
|
| 5 |
-
|
| 6 |
-
---
|
| 7 |
-
|
| 8 |
-
## 2025-10-26 — Brownfield Spec Init
|
| 9 |
-
|
| 10 |
-
### 新增
|
| 11 |
-
- **`spec/spec.md`**(v1.0):完整規格書
|
| 12 |
-
- 系統架構、I/O 契約、不變條件、限制
|
| 13 |
-
- 錯誤處理與日誌原則(spec #1–#7)
|
| 14 |
-
- 資源依賴、擴充指南、版本管理
|
| 15 |
-
- 審核檢查清單
|
| 16 |
-
- **`spec/plan.md`**:迭代計畫模板(待填)
|
| 17 |
-
- **`spec/task-template.md`**:任務拆解模板(待填)
|
| 18 |
-
|
| 19 |
-
### 說明
|
| 20 |
-
- 基於現有 `app.py` 與 README.md 進行 Brownfield 盤點
|
| 21 |
-
- 正式化 I/O 契約、不變條件、降級策略
|
| 22 |
-
- 確立長期設計參考點(`spec/spec.md`)與短期迭代計畫(`spec/plan.md`、`spec/task.md`)
|
| 23 |
-
|
| 24 |
-
### 後續工作清單
|
| 25 |
-
- [ ] 驗證 spec 對應現有程式碼(app.py、ttsam_realtime.py)
|
| 26 |
-
- [ ] 若發現差異或缺漏,更新 spec 或程式碼
|
| 27 |
-
- [ ] 根據開發需求,在 `spec/plan.md` 定義下一迭代目標
|
| 28 |
-
- [ ] 進行程式碼審核,確保滿足 spec 第 10 節檢查清單
|
| 29 |
-
|
| 30 |
-
---
|
| 31 |
-
|
| 32 |
-
**End of Change Log**
|
| 33 |
-
|
| 34 |
-
*此檔案記錄每個迭代/變更的高層摘要。詳細內容應參考 `spec/spec.md` 與 git commit 訊息。*
|
| 35 |
-
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|