先決定你現在是要學,還是要在專案裡做
網站負責解釋與分發工作包;真正的 Repository 掃描、缺口判斷與文件產出交給 Coding Agent。
SDLC 實作課 · 交付物練習
先理解這份文件替你消除什麼不確定
把『部署』與『發布』拆開
把上線風險從「不能合進主幹」變成「合進去但默認關閉」。Flag 是 trunk-based、canary、AB、kill switch 的共同基石。
誰負責、交給誰
主責: Dev 寫 flag、PO 決定開關時機
協作: SRE 監控 flag 對 SLO 影響、QA 驗 on/off 雙路徑
下游收件: Release Plan、Canary Strategy、Rollback Plan
何時值得做
必要時機: 高風險變更、AB 實驗、依賴未就緒、需逐步放量
不需要時: 純 bug fix、安全 patch、UI 文字
常見誤用: flag 不設過期;flag 之間互相耦合;on/off 路徑不測
- 01讀大綱
- 02比範本
- 03填素材
- 04貼提示詞
- 05對照驗收
Anatomy · 文件解剖
輕量版先回答 6 個核心章節
章節名稱可以因團隊調整,但每一段要求的判斷不能被省略。先讀問題,再看格式。
- 01
Executive Summary
範本必要章節
3-5 行,Dev/SRE/PO 30 秒讀完。內容:flag 名、保護什麼變更、預計 rollout 期、kill switch 條件
- 02
Flag Identity
範本必要章節
命名必含模組 prefix(snake_case),對齊既有 inventory 規約
- 04
Owners & Lifecycle
範本必要章節
DRI + cleanup owner 必填(可同人);expiry 缺失視為不合格
- 05
Telemetry & Kill Switch
範本必要章節
必有 exposure metric + SLO impact metric + kill switch alert 三件
- 09
Risks(top 3)
範本必要章節
每條格式:失效模式 + Mitigation + Owner 三件齊
- 12
Confidence & Sources & TODO
範本必要章節
把已確認的內容、判斷依據與仍待補充的資訊清楚分開。
Study · 對照學習
同一份交付物,先練核心,再看完整深度
輕量範本適合第一次練習與 MVP;完整範本保留跨職能交棒需要的細節。兩者都要求未知事項保持可見。
這張卡目前提供已審定的輕量與完整範本;不以 AI 臨時生成的內容冒充實際案例。
30 分鐘內先完成核心章節。
---
doc_type: "feature-flag"
variant: "light"
status: "draft"
owner: "<your-name>"
last_updated: "YYYY-MM-DD"
upstream:
required: ["git-diff", "flag-inventory"]
optional: ["release-plan"]
---
# Feature Flag: <flag-name>
**Status:** Draft v0.X · **Owner:** <Dev DRI> · **Last updated:** YYYY-MM-DD
> [!IMPORTANT]
> **AI 填寫規則:** 本範本 6 段(編號 1, 2, 4, 5, 9, 12),全部必填——刻意沿用完整版的章節編號讓兩版可對照。每結論行內加 `(依據:diff path:line / release-plan §X)`;每量化欄位帶 `[H]/[M]/[L]` confidence badge;缺資料寫 `_TODO: 需要 XXX_` 不編造;**flag 必須有 expiry_date(≤ 90 天)+ cleanup owner + fallback**,缺一視為不合格。
---
## 1. Executive Summary
<!-- ai-fill: 3-5 行,Dev/SRE/PO 30 秒讀完。內容:flag 名、保護什麼變更、預計 rollout 期、kill switch 條件 -->
<3-5 行說明>
> **TL;DR:** <一句話:這個 flag 把哪個變更從「不能合」變成「合進去但預設關閉」>
---
## 2. Flag Identity
<!-- ai-rule: 命名必含模組 prefix(snake_case),對齊既有 inventory 規約 -->
| Field | Value | Confidence |
|---|---|---|
| **Name** | `<module>_<feature>` (e.g. `checkout_new_pricing`) | **[H]** |
| **Type** | release / experiment / ops / permission | **[H]** |
| **Scope** | rollout %: 0-100 / segment / region | **[H]** |
| **Expiry date** | YYYY-MM-DD (≤ 90 天) | **[H]** |
---
## 4. Owners & Lifecycle
<!-- ai-rule: DRI + cleanup owner 必填(可同人);expiry 缺失視為不合格 -->
- **DRI:** <person or team>
- **Cleanup owner:** <負責退役>
- **Escalation:** <on-call rotation>
- **Cleanup trigger:** <e.g. rollout = 100% sustained 14 days OR expiry_date reached>
---
## 5. Telemetry & Kill Switch
<!-- ai-rule: 必有 exposure metric + SLO impact metric + kill switch alert 三件 -->
| Signal | Name | Threshold |
|---|---|---|
| **Exposure** | `flag.<name>.exposure` | track on/off ratio |
| **SLO impact** | <e.g. error_rate by flag> | < 1% |
| **Kill switch alert** | <e.g. error_rate > 1% sustained 5min> | auto-disable flag |
**Fallback on flag eval failure:** <e.g. default to off — 保守路徑>
---
## 9. Risks(top 3)
<!-- ai-rule: 每條格式:失效模式 + Mitigation + Owner 三件齊 -->
> **R1:** <風險描述> — **Mitigation:** <如何降低> — **Owner:** <誰負責>
>
> **R2:** ...
>
> **R3:** ...
---
## 12. Confidence & Sources & TODO
- **整份文件最低 confidence 欄位:** <列出所有 [L] 與 [M]>
- **Fabricated assumptions(推測但 input 未明說):**
- <假設 1>
- **Highest-value next input:** <下一份最該補的 SLO 定義 / incident postmortem>
### TODO(缺資料)
- _TODO: 需要 SLO 數值校準 kill switch threshold_
---
> [!CAUTION]
> **輸出前 AI 自檢:**
> - [ ] 6 段 H2 章節齊全(編號 1, 2, 4, 5, 9, 12,刻意不連號)
> - [ ] Flag name 含模組 prefix + snake_case
> - [ ] Expiry date 存在且 ≤ 90 天
> - [ ] DRI + cleanup owner 兩者皆填
> - [ ] Telemetry 三件齊:exposure + SLO impact + kill switch alert
> - [ ] Fallback on eval failure 已寫
> - [ ] Risks 每條格式:失效模式 + Mitigation + Owner
> - [ ] 無 YAML / JSON schema 輸出(spec 是給人讀的 markdown)Practice · 換你試做
先用自己的話交代素材,不需要先學會工程術語
確定的就寫,不確定的留白。下一步要做的是請 Agent 找缺口,不是讓它替你猜一套合理答案。
可以先留白;複製提示詞後再到 Coding Agent 裡補充。
AI Practice · 手動三步
先問、再寫、最後審,不把整條流程鎖死
每一步都是獨立工作包。你可以停下補資料、修改限制或重做某一步,不需要服從固定的 Agent 接力流程。
只找阻擋文件成立的未知
先補會改變範圍、判斷或驗收結果的資訊,不急著寫文件。
我要製作「Feature Flag · 功能旗標」。先不要產出文件。
請根據我的素材,找出會影響這份文件正確性或可執行性的未知事項,一次最多問 5 題。
每題請包含:
1. 問題
2. 為什麼現在必須知道
3. 它會影響哪個章節或決定
已經回答的事不要重問;可以延後的事標成「待決策」;不要替我猜答案。
本文件的核心章節:Executive Summary、Flag Identity、Owners & Lifecycle、Telemetry & Kill Switch、Risks(top 3)、Confidence & Sources & TODO複製後,請在標示位置貼上自己的素材。
Review · 自己驗收
文件存在,不代表下一個角色真的能使用
逐條檢查 Agent 的輸出。人類負責需求、限制與驗收,也必須能說明重要結論從哪裡來。
帶著這份文件,繼續到「CI/CD Pipeline · 持續交付管線」
下一張卡會接住新的決策問題;不用一次把整條 SDLC 全做完。
