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
+16
View File
@@ -66,6 +66,22 @@ export function assertNeutralPrompt(prompt, command) {
}
}
/**
* 取出正本裡某一個編號步驟的內容,**以名字取而不是以編號取**。
* 步驟會增刪、編號會整批位移,名字不會;用編號寫的測試會在別人插一步時無聲地
* 框到另一段內容上,而那種失敗看起來像是正本掉了東西。
* @param {string} prompt 正本內容
* @param {string} name 步驟名,例如 '產生圖解版總覽'
* @returns {string} 該步驟的標題與內文,到下一個 `### ` 為止
*/
export function promptStep(prompt, name) {
const start = prompt.search(new RegExp(`^### \\d+\\. ${name}$`, 'm'));
assert.ok(start >= 0, `正本裡找不到「${name}」這一步`);
const rest = prompt.slice(start);
const end = rest.slice(1).search(/^### /m);
return end === -1 ? rest : rest.slice(0, end + 1);
}
/**
* 斷言模板的 `## 標題` 就是這組段落,順序一致。
* 段落順序即下游抽取契約的解析依據,兩邊必須一起改。
+7 -5
View File
@@ -3,13 +3,15 @@
*/
import test from 'node:test';
import assert from 'node:assert/strict';
import { readPrompt, readTemplateFile } from './helpers/prompt-doc.js';
import { promptStep, readPrompt, readTemplateFile } from './helpers/prompt-doc.js';
const template = readTemplateFile('overview-artifact.html');
const planPrompt = readPrompt('sdlc-plan');
const analyzePrompt = readPrompt('sdlc-analyze');
/** 只看產生總覽那一步,避免拿整份正本的任何一處來充數 */
const planStep = planPrompt.slice(planPrompt.indexOf('### 6.'), planPrompt.indexOf('### 7.'));
const planStep = promptStep(planPrompt, '產生圖解版總覽');
/** 分析版的那一步,同樣只看它自己 */
const analyzeStep = promptStep(analyzePrompt, '產生分析版的圖解總覽');
/** 模板要填的欄位 */
const PLACEHOLDERS = ['標題', '來源議題', '總覽', '目標', '流程圖', '工作包全景', '頁尾'];
@@ -86,7 +88,7 @@ test('正本說明這份網頁是給非技術的人看的', () => {
// ── sdlc-analyze 的步驟 ────────────────────────────────────────────
test('分析正本的全景圖用 graph TD,並畫出相依與時程', () => {
const step = analyzePrompt.slice(analyzePrompt.indexOf('### 11.'));
const step = analyzeStep;
assert.match(step, /graph TD/);
assert.match(step, /相依/);
assert.match(step, /截止日/);
@@ -97,13 +99,13 @@ test('分析正本沿用同一份模板,不另立一份', () => {
});
test('全景圖一樣有節點上限,超過時的做法有交代', () => {
const step = analyzePrompt.slice(analyzePrompt.indexOf('### 11.'));
const step = analyzeStep;
assert.match(step, /12/);
assert.match(step, /最長路徑/);
});
test('分析正本說明重跑會就地更新,不會留下兩個連結', () => {
const step = analyzePrompt.slice(analyzePrompt.indexOf('### 11.'));
const step = analyzeStep;
assert.match(step, /就地更新/);
assert.match(step, /只掛一個總覽網址/);
});
+42 -4
View File
@@ -4,7 +4,7 @@
*/
import test from 'node:test';
import assert from 'node:assert/strict';
import { assertNeutralPrompt, readPrompt, readReference } from './helpers/prompt-doc.js';
import { assertNeutralPrompt, promptStep, readPrompt, readReference } from './helpers/prompt-doc.js';
const prompt = readPrompt('sdlc-analyze');
@@ -78,16 +78,54 @@ test('正本規定最後輸出共識摘要,且摘要只印不寫', () => {
test('正本把「共識摘要之前不寫入」寫成明確邊界', () => {
const boundary = prompt.slice(prompt.indexOf('## 邊界'));
assert.match(boundary, /共識摘要之前不對 Gitea 產生任何寫入/);
assert.match(boundary, /共識摘要之前不對 Gitea 寫入任何內容/);
assert.match(boundary, /不建議題/);
assert.match(boundary, /不留留言/);
});
test('第一段在共識摘要之前不叫用任何寫入型腳本', () => {
test('第一段在共識摘要之前不寫入任何內容,碼錶是唯一的例外', () => {
const analysis = prompt.slice(prompt.indexOf('## 第一段'), prompt.indexOf('## 第二段'));
for (const writer of ['issue-create', 'issue-update', 'issue-link', 'project-add', 'timer']) {
for (const writer of ['issue-create', 'issue-update', 'issue-link', 'project-add']) {
assert.equal(analysis.includes(writer), false, `第一段不該出現寫入型腳本 ${writer}`);
}
assert.match(analysis, /timer\.js/, '錶要起在第一段開頭,分析最耗時的正是共識之前那一段');
});
// ── 計時 ───────────────────────────────────────────────────────────
test('起錶排在第一段開頭,停錶排在最後的回報,兩者成對出現', () => {
const 起 = prompt.indexOf(promptStep(prompt, '起錶'));
assert.ok(起 > prompt.indexOf(promptStep(prompt, '讀議題')), '讀完議題確認它存在之後才起');
assert.ok(起 < prompt.indexOf('## 第二段'), '起錶要在第一段之內:分析最耗時的是共識之前那一段');
assert.match(promptStep(prompt, '停錶並回報'), /--stop/, '停錶與最後的回報寫在同一步');
});
test('起錶與停錶指的都是同一顆需求議題', () => {
const 計時段 = [...prompt.matchAll(/node scripts\/timer\.js[^\n]*/g)].map((m) => m[0]);
assert.ok(計時段.length >= 2, '起錶與停錶都要寫在正本裡');
for (const line of 計時段) {
assert.match(line, /--index <需求議題編號>/, `錶要起停在需求議題上:${line}`);
}
});
test('正本寫出這段計時涵蓋到哪,讀的人不必自己推', () => {
assert.match(prompt, /## 計時範圍/);
assert.match(prompt, /錶不跨階段跑/);
});
test('正本交代錶已經跑在同一顆上時不重起,不把累積時間切成兩段', () => {
assert.match(prompt, /切成兩段/);
});
test('正本明令不代停別顆議題上的錶', () => {
assert.match(prompt, /請他自己去停/);
assert.match(prompt, /不停別顆議題上的錶/);
});
test('邊界把碼錶從「不寫入」裡明文除外,並寫出理由', () => {
const boundary = prompt.slice(prompt.indexOf('## 邊界'));
assert.match(boundary, /碼錶除外/);
assert.match(boundary, /工時/, '要說清楚碼錶記的是工時不是內容,否則下一個人會把它刪掉');
});
test('正本要求先看未處理留言數,不是 0 就提示先整併', () => {
+5 -3
View File
@@ -66,7 +66,7 @@ test('領取鎖的四種狀態各自交代了下一步,含放行那一種', ()
});
test('缺標籤是前置條件,不混進領取鎖的四種狀態裡', () => {
const table = phase1.slice(phase1.indexOf('| 狀態'), phase1.indexOf('碼錶一律由使用者自己停'));
const table = phase1.slice(phase1.indexOf('| 狀態'), phase1.indexOf('鎖以外還有一個前置條件'));
assert.equal(table.includes('LABEL_NOT_FOUND'), false, '它不是鎖的狀態,別讓四種變五種');
assert.match(phase1, /LABEL_NOT_FOUND/, '但仍要交代它,否則使用者不知道怎麼辦');
});
@@ -88,9 +88,11 @@ test('被碼錶擋下時要說明停錶不會動到工作樹', () => {
assert.match(phase1, /以為停錶等於放棄那顆工作包/, '要說明不講清楚的後果');
});
test('碼錶只由使用者自己停,並說明為什麼不代勞', () => {
assert.match(phase1, /由使用者自己停/);
test('別顆議題上的錶只由使用者自己停,並說明為什麼不代勞', () => {
assert.match(phase1, /別顆議題上的錶一律由使用者自己停/);
assert.match(phase1, /工時記錯地方/);
// 這一道自己起的那一支要自己停,否則錶會跨階段跑;兩件事不能混成一句「一律不停」
assert.match(phase1, /停掉的只有自己起的那一支/);
});
test('來源分支要問過使用者,且一次一題、附理由與手動輸入', () => {
+47
View File
@@ -12,6 +12,7 @@ import {
assertNeutralPrompt,
assertPromptListsSections,
assertTemplateSections,
promptStep,
readPrompt,
readTemplate,
} from './helpers/prompt-doc.js';
@@ -19,6 +20,9 @@ import {
const template = readTemplate('requirement-issue');
const prompt = readPrompt('sdlc-plan');
/** 某一步在正本裡的位置;以名字取而不是以編號取,插一步不會讓這些測試框錯段落 */
const at = (name) => prompt.indexOf(promptStep(prompt, name));
/** 需求議題的九個段落,順序即議題裡的順序 */
const SECTIONS = [
'總覽',
@@ -99,3 +103,46 @@ test('正本交代了畫與不畫兩種情況各該填什麼', () => {
assert.match(prompt, /```mermaid/);
assert.match(prompt, /不要加圍欄|不加圍欄/);
});
// ── 計時 ───────────────────────────────────────────────────────────
test('正本寫出這段計時涵蓋到哪,讀的人不必自己推', () => {
assert.match(prompt, /## 計時範圍/);
assert.match(prompt, /錶不跨階段跑/);
});
test('議題建立之前先記下開始時間:那時候還沒有標的可起錶', () => {
assert.ok(at('記下開始時間') < at('先試跑,再寫入'), '要在議題建立之前就記下');
assert.match(promptStep(prompt, '記下開始時間'), /不要憑印象回推/);
});
test('補登排在議題建立之後、起錶之前,三者指向同一顆議題', () => {
const 補登 = prompt.indexOf('time-log.js');
const 起錶 = prompt.indexOf('timer.js');
assert.ok(at('先試跑,再寫入') < 補登, '議題還不存在時無處可補');
assert.ok(補登 < 起錶, '順序反過來的話補登會被當成做過了而跳過');
for (const line of [...prompt.matchAll(/node scripts\/(?:time-log|timer)\.js[^\n]*/g)]) {
assert.match(line[0], /--index <編號>/, `補登與起錶要指向同一顆議題:${line[0]}`);
}
});
test('補登的長度由腳本算,不要 agent 自己做減法', () => {
assert.match(prompt, /--since <記下的開始時間>/);
assert.match(prompt, /不必自己做減法/);
});
test('補登不設時間上限,也不因為時間長就改口問使用者', () => {
assert.match(prompt, /不設時間上限/);
assert.match(prompt, /不必為此多長一題出來問使用者/);
});
test('停錶排在最後的回報那一步,與起錶成對', () => {
assert.match(promptStep(prompt, '停錶並回報'), /--stop/, '停錶與回報寫在同一步');
assert.ok(at('補登規劃時間,然後起錶') < at('停錶並回報'), '先起才有得停');
});
test('正本明令不代停別顆議題上的錶', () => {
assert.match(prompt, /請他自己去停/);
const boundary = prompt.slice(prompt.indexOf('## 邊界'));
assert.match(boundary, /不停別顆議題上的錶/);
});
+1 -1
View File
@@ -62,7 +62,7 @@ test('人天估算的 API 限制寫成獨立一節,不是藏在行文裡', ()
test('邊界把三段各自不做的事分開列', () => {
const boundary = prompt.slice(prompt.indexOf('## 邊界'));
assert.match(boundary, /共識摘要之前不對 Gitea 產生任何寫入/);
assert.match(boundary, /共識摘要之前不對 Gitea 寫入任何內容/);
assert.match(boundary, /第二段只建立工作包議題/);
assert.match(boundary, /第三段只掛既有的 Milestone 與看板/);
});