先決定你現在是要學,還是要在專案裡做
網站負責解釋與分發工作包;真正的 Repository 掃描、缺口判斷與文件產出交給 Coding Agent。
SDLC 實作課 · 交付物練習
先理解這份文件替你消除什麼不確定
讓重構不再靠賭
Unit Test 真正的價值不是「測對了」,是「敢改」。沒測試的程式碼就是凍住的。覆蓋率是副產品,可重構性才是目標。
誰負責、交給誰
主責: Dev 寫測試與被測對象
協作: QA 對齊 acceptance、SD 對齊錯誤模型
下游收件: CI、Integration Test、Refactor 安全網
何時值得做
必要時機: 業務規則、狀態機、資料轉換、價格/權限計算
不需要時: 純 wiring code、setter/getter、UI snapshot
常見誤用: 為覆蓋率測 mock、把 unit 寫成 integration
- 01讀大綱
- 02看案例
- 03填素材
- 04貼提示詞
- 05對照驗收
Anatomy · 文件解剖
輕量版先回答 6 個核心章節
章節名稱可以因團隊調整,但每一段要求的判斷不能被省略。先讀問題,再看格式。
- 01
Executive Summary
範本必要章節
3-5 行,Dev 30 秒讀完。內容:N 個 target、N 個 test case、覆蓋哪些 case 類別
- 02
Targets
範本必要章節
kind + name + signature + public_api 四件齊
- 03
Test Cases(3 categories minimum)
範本必要章節
至少 happy / boundary / error 三類,每條附 input / expected / edge_rationale
- 04
Mocking Strategy
範本必要章節
mock / do_not_mock + rationale。預設不 mock 同 module pure function
- 09
Risks(top 3)
範本必要章節
每條格式:失效模式 + Mitigation + Owner 三件齊
- 12
Confidence & Sources & TODO
範本必要章節
把已確認的內容、判斷依據與仍待補充的資訊清楚分開。
Study · 對照學習
同一份交付物,先練核心,再看完整深度
輕量範本適合第一次練習與 MVP;完整範本保留跨職能交棒需要的細節。兩者都要求未知事項保持可見。
30 分鐘內先完成核心章節。
---
doc_type: "unit-test"
variant: "light"
status: "draft"
owner: "<your-name>"
last_updated: "YYYY-MM-DD"
upstream:
required: ["function-signature", "spec"]
optional: ["existing-coverage"]
---
# Unit Test Plan: <module-or-function-name>
**Status:** Draft v0.X · **Owner:** <Dev> · **Last updated:** YYYY-MM-DD
> [!IMPORTANT]
> **AI 填寫規則:** 本範本 6 段(編號 1, 2, 3, 4, 9, 12),全部必填——刻意沿用完整版的章節編號讓兩版可對照。每 test case 行內加 `(依據:spec §X / signature 推導)`;每 case 帶 `[H]/[M]/[L]` confidence badge;缺資料寫 `_TODO: 需要 XXX_` 不編造;**輕量版至少覆蓋 happy + boundary + error 三類**;不測 wiring code / setter / getter;不 mock 同 module 內 pure function。
---
## 1. Executive Summary
<!-- ai-fill: 3-5 行,Dev 30 秒讀完。內容:N 個 target、N 個 test case、覆蓋哪些 case 類別 -->
<3-5 行說明>
> **TL;DR:** <一句話:這份 plan 解什麼重構恐懼>
---
## 2. Targets
<!-- ai-rule: kind + name + signature + public_api 四件齊 -->
| Kind | Name | Signature | Public API | Confidence |
|---|---|---|---|---|
| function | `<fqn>` | `(input: T) => R` | true | **[H]** |
---
## 3. Test Cases(3 categories minimum)
<!-- ai-rule: 至少 happy / boundary / error 三類,每條附 input / expected / edge_rationale -->
### TC-001 · Category **happy** · **[H]**
- **Target:** `<fqn>`
- **Input:** `<inline value>`
- **Expected:** `<value 或 exception>`
- **Edge rationale:** 標準路徑
- **Source:** spec §XX
### TC-002 · Category **boundary** · **[H]**
- **Target:** `<fqn>`
- **Input:** `<邊界值,例:max int>`
- **Expected:** `<value>`
- **Edge rationale:** 邊界條件
### TC-003 · Category **error** · **[H]**
- **Target:** `<fqn>`
- **Input:** `<無效 input>`
- **Expected:** `throw ValidationError`
- **Edge rationale:** 錯誤路徑
---
## 4. Mocking Strategy
<!-- ai-rule: mock / do_not_mock + rationale。預設不 mock 同 module pure function -->
| Action | Items | Rationale |
|---|---|---|
| **Mock** | external IO / time / random / network | 不可控 |
| **Do not mock** | same-module pure function / value object | 同邏輯邊界 |
---
## 9. Risks(top 3)
<!-- ai-rule: 每條格式:失效模式 + Mitigation + Owner 三件齊 -->
> **R1:** <風險描述> — **Mitigation:** <如何降低> — **Owner:** <誰負責>
>
> **R2:** ...
>
> **R3:** ...
---
## 12. Confidence & Sources & TODO
- **整份 plan 最低 confidence 項:** <列出所有 [L] 與 [M]>
- **Fabricated assumptions(推測但 input 未明說):**
- <假設 1>
- **Highest-value next input:** <下一份最該補的 spec 細節 / production error log>
### TODO(缺資料)
- _TODO: spec 沒寫錯誤訊息文案,TC-003 expected 待補_
---
> [!CAUTION]
> **輸出前 AI 自檢:**
> - [ ] 6 段 H2 章節齊全(編號 1, 2, 3, 4, 9, 12,刻意不連號)
> - [ ] 至少覆蓋 happy + boundary + error 三類
> - [ ] 每個 test case 帶 inline `[H/M/L]` badge + source
> - [ ] Mocking Strategy 含 do_not_mock 並寫 rationale
> - [ ] Risks 每條格式:失效模式 + Mitigation + Owner
> - [ ] 無 YAML / JSON schema 輸出(plan 是給人讀的 markdown)Practice · 換你試做
先用自己的話交代素材,不需要先學會工程術語
確定的就寫,不確定的留白。下一步要做的是請 Agent 找缺口,不是讓它替你猜一套合理答案。
可以先留白;複製提示詞後再到 Coding Agent 裡補充。
AI Practice · 手動三步
先問、再寫、最後審,不把整條流程鎖死
每一步都是獨立工作包。你可以停下補資料、修改限制或重做某一步,不需要服從固定的 Agent 接力流程。
只找阻擋文件成立的未知
先補會改變範圍、判斷或驗收結果的資訊,不急著寫文件。
我要製作「Unit Test · 單元測試」。先不要產出文件。
請根據我的素材,找出會影響這份文件正確性或可執行性的未知事項,一次最多問 5 題。
每題請包含:
1. 問題
2. 為什麼現在必須知道
3. 它會影響哪個章節或決定
已經回答的事不要重問;可以延後的事標成「待決策」;不要替我猜答案。
本文件的核心章節:Executive Summary、Targets、Test Cases(3 categories minimum)、Mocking Strategy、Risks(top 3)、Confidence & Sources & TODO複製後,請在標示位置貼上自己的素材。
Review · 自己驗收
文件存在,不代表下一個角色真的能使用
逐條檢查 Agent 的輸出。人類負責需求、限制與驗收,也必須能說明重要結論從哪裡來。
帶著這份文件,繼續到「Integration Test · 整合測試」
下一張卡會接住新的決策問題;不用一次把整條 SDLC 全做完。
