docs(sdlc-plan,sdlc-analyze): 兩份正本各自起停自己的錶

起錶與停錶寫在同一份正本裡成對出現,讀的人一眼看得出這段計時涵蓋到哪;兩份各加一節
「計時範圍」把兩端指出來。

sdlc-plan 記兩段:議題建立之前那段在第一步記下開始時間、議題建立之後以補登記上去;
之後起錶,回報那一步停錶。補登排在議題建立之後、起錶之前,順序反過來的話補登會被
time-log 當成「這一步做過了」而跳過。

sdlc-analyze 在它分析的那顆需求議題上起錶,起點放在第一段開頭——分析最耗時的正是
共識之前那一段,從第二段才起的話那段時間永遠是零。因此「共識摘要之前不對 Gitea
產生任何寫入」改寫成「不寫入任何**內容**」,並把碼錶明文除外、寫上理由:它記的是
工時,不是內容。這一條與 repo 擁有者確認過。

sdlc-feat 的「碼錶一律由使用者自己停」收斂成「**別顆議題上的**錶一律由使用者自己停」
——它原本讀起來像全域規則,而現在每道指令都會停自己起的那一支。

正本之間改以步驟**名稱**互指,不用編號:編號會整批位移,名字不會。測試跟著改用新的
promptStep 輔助函式,以名字框出某一步的內容,別人插一步時不會無聲地框到另一段上。

議題 #57

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
This commit is contained in:
2026-09-17 19:32:37 +08:00
co-authored by Claude Opus 5
parent 81d02bffcf
commit 7ee050de2f
9 changed files with 246 additions and 36 deletions
+70 -7
View File
@@ -19,13 +19,36 @@ description: 僅由 /sdlc-plan 指令叫用。把一段口語需求轉成結構
`scripts/issue-extract.js` 取(若該腳本尚未可用,改用 `scripts/issue-create.js` 以外的
既有讀取途徑,並在摘要中註明資料來源)。
## 計時範圍
這份正本把整個 /sdlc-plan 的耗時記成兩段,合起來就是這道指令實際花掉的時間:
- **議題建立之前** — 在「記下開始時間」記下起點,在「補登規劃時間,然後起錶」補上去。
議題還不存在,沒有標的可起錶。
- **議題建立之後** — 在「補登規劃時間,然後起錶」起錶,在「停錶並回報」停錶。
起與停都寫在這一份裡,**錶不跨階段跑**:跑完就去開會而錶跑一整天,報表當場失真。
反過來,別顆議題上的錶一律不碰——那一段時間該記在哪顆議題上只有使用者知道。
## 步驟
### 1. 讀齊輸入,列出還缺什麼
### 1. 記下開始時間
讀齊輸入、逐項詢問、組出議題內容,往往是整個 plan 最耗時的一段,而它發生在議題建立
**之前**——那時候沒有標的可起錶。所以先把此刻的時間記下來,等議題建立之後補登上去:
```
node -e "console.log(new Date().toISOString())"
```
記下它,一路帶到「補登規劃時間,然後起錶」那一步。**不要憑印象回推**:補登的長度就是
報表上規劃階段的數字。
### 2. 讀齊輸入,列出還缺什麼
把九個段落逐一對照使用者給的材料,列出哪些段落已經有依據、哪些沒有。
### 2. 逐項詢問
### 3. 逐項詢問
**一次問一題**,等使用者回答完再問下一題,讓他能看著前一題的答案回答下一題。
@@ -34,7 +57,7 @@ description: 僅由 /sdlc-plan 指令叫用。把一段口語需求轉成結構
**未獲得答覆的欄位不得自行編造。** 使用者沒說過的目標、沒提過的驗收標準,一個字都不能自己
填。問不到就放進「未決事項」,那一段本來就是給未決的東西用的。
### 3. 組出議題內容
### 4. 組出議題內容
套用 `templates/requirement-issue.md`,依序填滿九個段落:
@@ -49,13 +72,13 @@ description: 僅由 /sdlc-plan 指令叫用。把一段口語需求轉成結構
8. **影響範圍** — 會動到哪些 repo、哪些既有功能。
9. **未決事項** — 問不到答案、或需要他人拍板的事。
### 4. 挑標籤
### 5. 挑標籤
先用 `scripts/labels-list.js --repo <owner/name>` 取得該 repo 的既有標籤,**只能從這份清單裡
挑**。找不到合適的就不貼。**不得自行建立新標籤** —— 標籤體系由專案維護者決定,不該在多個
repo 之間長出雜草。
### 5. 先試跑,再寫入
### 6. 先試跑,再寫入
把組好的內容寫到一個暫存檔,然後:
@@ -69,7 +92,36 @@ node scripts/issue-create.js --repo <owner/name> --title "<標題>" --body-file
同一段需求重跑不會產生第二顆議題:`issue-create` 以標題查重,發現同名議題就回傳既有那一顆
並把 `created` 設為 `false`。
### 6. 產生圖解版總覽
### 7. 補登規劃時間,然後起錶
議題有了,計時才有標的。**先補登、再起錶**,兩步指向同一顆議題。
先把「記下開始時間」到議題建立那一段補上去:
```
node scripts/time-log.js --repo <owner/name> --index <編號> --since <記下的開始時間> --dry-run
```
長度由腳本自己算——它讀議題的建立時間減掉 `--since`,所以不必自己做減法,也不會讓
兩邊的時鐘各算一次。確認無誤後拿掉 `--dry-run` 再跑一次。
**不設時間上限,照實補登。** 中途去開會的那兩個小時會一起被算進去,這是刻意的:換來
這個流程不必為此多長一題出來問使用者。時間記多了看得出來,記不到就永遠找不回來。
補登完才起錶:
```
node scripts/timer.js --repo <owner/name> --index <編號> --dry-run
```
一樣先試跑,確認無誤後拿掉 `--dry-run` 再跑一次。順序反過來的話補登會被當成「這一步做過了」而跳過——錶在這顆議題上跑著,正是
`time-log` 判斷補過了的依據之一,它也因此重跑不會愈補愈多。
錶已經跑在別顆議題上時起錶會被擋下(`STOPWATCH_ON_OTHER_ISSUE`)。**照實告訴使用者
是哪一顆,請他自己去停**,不要代勞:那一段時間該記在哪顆議題上只有他知道。順帶說明
停錶不會動到任何既有的工作樹——碼錶只管時間、工作樹只管檔案。
### 8. 產生圖解版總覽
套用 `templates/overview-artifact.html`,把議題的總覽、目標與流程圖填成一份可以直接投影的
網頁。這一份是給**非技術的利害關係人**看的:他們不必讀完技術細節就知道這件事在做什麼。
@@ -96,7 +148,16 @@ node scripts/issue-update.js --repo <owner/name> --index <編號> --overview-url
議題原本的 markdown 白話總覽一字不動——網頁是補充,不是取代。連結旁會自動附上
「此連結預設為私有,組織外無法開啟」,因為讀到的人多半會想轉寄給組織外的人。
### 7. 回報
### 9. 停錶並回報
回報之前先停錶,這一段計時到此為止:
```
node scripts/timer.js --repo <owner/name> --index <編號> --stop
```
它**只停這一顆**上的錶。錶本來就沒在跑不算失敗(`碼錶已停` 會是 `false` 並附一句
說明),回報照樣做完。
把議題編號與網址告訴使用者。不要把整份議題內容再貼一次 —— 連結點進去就看得到。
@@ -122,3 +183,5 @@ node scripts/issue-update.js --repo <owner/name> --index <編號> --overview-url
- 不建立標籤、不建立 Milestone、不建立專案看板。
- 不關閉或刪除任何既有議題。
- 規劃階段本身已含問題釐清,因此寫入 Gitea 前不再設額外的確認點;`--dry-run` 就是那道關卡。
- 計時只動這顆需求議題:在它上面起錶、在它上面停錶、把規劃時間補登在它上面。
**不停別顆議題上的錶**,被別顆的錶擋下時交還給使用者決定,不繞過去。