| name | branch-ticket-issue-doc |
| description | 在 ticket-id-dev-prep 已選定或準備好開發工作區,且 Codex 需從 advisor 解析的 brief、GitHub issue 細節與當前工作區程式碼脈絡建立或更新 docs/issues/<issue-id>.md 時使用此 skill;只聚焦於記錄問題,不撰寫 specs 或程式碼。 |
Branch Ticket Issue Doc
在 ticket-id-dev-prep 選定的開發工作區中使用此 skill。
目標:建立或更新 docs/issues/<ticket-id>.md,作為該 branch 的正規問題文件。
不要在此建立 specs。不要在此變更產品程式碼。
前置條件
- 確認當前目錄是預期的開發工作區。
- 確認當前 branch 含 ticket id,或使用者明確提供 ticket id。
- 優先使用來自
branch-ticket-solution-advisor 的已解析 brief。
- 若無已解析 brief,閱讀 GitHub issue,並僅檢視足以記錄問題的程式碼脈絡。
- 若
docs/issues/ 不存在則建立。
若 ticket-id-dev-prep 選定了不同的工作區,在寫入前切換過去。若選定策略為 current-branch 或 current-worktree-new-branch,則允許在當前工作區寫入。
工作流程
- 解析 ticket id。
- 若存在則讀取既有的
docs/issues/<ticket-id>.md。
- 若存在則讀取
docs/issues/template.md,並保留本地文件風格。
- 蒐集來源素材:
- advisor 已解析的 brief
- GitHub issue 標題與描述
- 相關欄位,例如
State、Type、Priority、Subsystem
- 透過針對性檢視得到的當前 worktree 程式碼觀察
- agy 優先策略:收集完所有資料後,優先委派 antigravity-cli(
agy)生成 issue doc 本文:
- (Fallback)自行依照 Issue Doc Template write or update
docs/issues/<ticket-id>.md。
- 區分事實、推論與未解問題。
- 讓 issue doc 聚焦於問題與當前行為。
- 除了簡短的程式碼脈絡觀察外,不要加入實作策略。
檔案命名
使用:
docs/issues/<TICKET-ID>-<description-suffix>.md
其中 <description-suffix> 取自當前 branch 名稱的最後一段路徑,並移除開頭的 ticket id 部分。
範例:
- Branch:
fix/202605/BUG-2362-some-feature-fix
- 最後一段:
BUG-2362-some-feature-fix
- Description suffix:
some-feature-fix
- 檔案:
docs/issues/BUG-2362-some-feature-fix.md
以下列指令解析 suffix:
git rev-parse --abbrev-ref HEAD | sed 's|.*/||' | sed 's/^[A-Z][A-Z]*-[0-9]*-//'
保留 ticket id 的大小寫。
Issue Doc Template
除非本地 template 要求更貼合的格式,否則使用此結構:
# <TICKET-ID> <title>
## Issue
- URL:
- State:
- Type:
- Priority:
## 問題描述
## 影響範圍
## 重現步驟
1.
## 預期結果
## 實際結果
## 環境
- App 版本:
- 裝置:
- OS 版本:
- 測試帳號:
## 程式碼現況
## 已知事實
## 推論
## 待確認
## 截圖 / 錄影
## 備註
僅在章節確實不適用時才省略空白章節。寧可填 待確認,也不要發明細節。
品質規則
- 問題文件必須不需讀完整 ticket 就能理解。
- 不要逐字複製冗長的 ticket 文字。
- 相關時保留確切的錯誤訊息、標籤、欄位名稱與使用者可見字串。
- 明確註記缺漏的重現資料。
- 若程式碼脈絡與 ticket 矛盾,記錄此不一致。
輸出規則
偏好的輸出:
Issue Doc:建立或更新的路徑
來源:advisor brief、GitHub issue、程式碼檢視
重點:一段簡短的問題摘要
待確認:僅在存在時
Next:執行 issue-spec-prep
風格規則
- 主要語言:
zh-tw
- 保留必要的
en-us 技術術語,例如 GitHub、State、API、UI、Backend、QA
- 精簡且以文件為導向