docs/npm-deploy-alignment/main #39

2026-09-17T07:11:48Z

jiantw83 commented

2026-09-17 07:11:48 +00:00

摘要

文件對齊現況。前置需求表原本把「缺少時印出指引並中止」套在所有需求上，但 tea-sdlc install 只警告不中止——文件描述的是一個不存在的行為。同時把 #30 的六條驗收標準真的變成測試，其中一條會把 README 裡的 tea-sdlc 指令逐行拿去執行。

需求議題

#1 — tea-sdlc：以 tea 驅動 SDLC 全流程的跨平台指令組

工作包議題

#30 — 改寫 README 與 AGENTS.md 對齊 npm 佈署

本票六條驗收標準中，前四條（npm 為唯一建議路徑／marketplace 流程移入附錄／補上 prompt 與 status 說明／AGENTS.md 新增指令入口一列）已在 #36 隨 #17 一併交付。本 PR 補上剩下的落差與缺的測試覆蓋。

變更內容

README.md：前置需求表改成逐項寫「缺了會怎樣」，並在表前點出「安裝與佈署只需要 Node」。
test/readme-install.test.js：新增三條測試——prompt 與 status 各自交代了誰在什麼時候用、前置需求表分得開安裝與跑流程、README 裡的 tea-sdlc 指令逐字執行得動；另把 AGENTS.md 指令入口那一列的職責與邊界欄位分開斷言。

設計重點

文件的正確性用執行來驗，不用眼睛核對。 新測試把 README bash 區塊裡的 tea-sdlc 指令逐行抽出來真的跑一次，家目錄指向空的暫存目錄，因此 install / uninstall 偵測不到任何平台、一個檔都不會寫。失敗理由若是 UNKNOWN_SUBCOMMAND / UNKNOWN_FLAG / MISSING_FLAG，就代表 README 寫了一個不存在的指令或參數。

測試會照 shell 的規則剝掉行內註解（空白後的 # 之後），因為 tea-sdlc status # 說明 貼進終端機本來就跑得動。

解決的問題

前置需求表在說一件不成立的事：照它寫的，沒裝 tea 就不能佈署，實際上 tea-sdlc install 會照樣把轉接檔裝好。這正是使用者最可能在第一次安裝時踩到的落差。

影響的功能

只動文件與測試，沒有任何行為變更。

測試結果

npm test 390 pass / 0 fail。

關於「README 不出現尚未實作的更新／移除指令表」這條

該條寫於 #17 完成之前，當時「移除要先跑 tea-sdlc uninstall 再 npm rm -g」確實是假的。#17 已於 #36 合併，該指令表描述的全部是已實作的行為，因此本條視為達成。

🤖 Generated with Claude Code

## 摘要文件對齊現況。前置需求表原本把「缺少時印出指引並中止」套在所有需求上，但 `tea-sdlc install` 只警告不中止——文件描述的是一個不存在的行為。同時把 #30 的六條驗收標準真的變成測試，其中一條會把 README 裡的 `tea-sdlc` 指令逐行拿去執行。 ## 需求議題 #1 — tea-sdlc：以 tea 驅動 SDLC 全流程的跨平台指令組 ## 工作包議題 #30 — 改寫 README 與 AGENTS.md 對齊 npm 佈署本票六條驗收標準中，前四條（npm 為唯一建議路徑／marketplace 流程移入附錄／補上 prompt 與 status 說明／AGENTS.md 新增指令入口一列）已在 #36 隨 #17 一併交付。本 PR 補上剩下的落差與缺的測試覆蓋。 ## 變更內容 - `README.md`：前置需求表改成逐項寫「缺了會怎樣」，並在表前點出「安裝與佈署只需要 Node」。 - `test/readme-install.test.js`：新增三條測試——prompt 與 status 各自交代了誰在什麼時候用、前置需求表分得開安裝與跑流程、README 裡的 `tea-sdlc` 指令逐字執行得動；另把 AGENTS.md 指令入口那一列的職責與邊界欄位分開斷言。 ## 設計重點 **文件的正確性用執行來驗，不用眼睛核對。** 新測試把 README bash 區塊裡的 `tea-sdlc` 指令逐行抽出來真的跑一次，家目錄指向空的暫存目錄，因此 `install` / `uninstall` 偵測不到任何平台、一個檔都不會寫。失敗理由若是 `UNKNOWN_SUBCOMMAND` / `UNKNOWN_FLAG` / `MISSING_FLAG`，就代表 README 寫了一個不存在的指令或參數。測試會照 shell 的規則剝掉行內註解（空白後的 `#` 之後），因為 `tea-sdlc status # 說明` 貼進終端機本來就跑得動。 ## 解決的問題前置需求表在說一件不成立的事：照它寫的，沒裝 tea 就不能佈署，實際上 `tea-sdlc install` 會照樣把轉接檔裝好。這正是使用者最可能在第一次安裝時踩到的落差。 ## 影響的功能只動文件與測試，沒有任何行為變更。 ## 測試結果 `npm test` 390 pass / 0 fail。 ## 關於「README 不出現尚未實作的更新／移除指令表」這條該條寫於 #17 完成之前，當時「移除要先跑 `tea-sdlc uninstall` 再 `npm rm -g`」確實是假的。#17 已於 #36 合併，該指令表描述的全部是已實作的行為，因此本條視為達成。 🤖 Generated with [Claude Code](https://claude.com/claude-code)

jiantw83 added 1 commit 2026-09-17 07:11:49 +00:00

docs(README): 前置需求分開講安裝與跑流程，並把指令是否真的跑得動釘住 cbf4c3df36

前置需求表原本一句「缺少時腳本印出指引並中止」套在所有需求上，但 install 只
警告不中止——文件描述的是一個不存在的行為。改成逐項寫「缺了會怎樣」，並把
「安裝只需要 Node」提到表前面：使用者不該為了裝 plugin 先去裝 tea。

另外補上三條把 #30 驗收標準真的驗起來的測試。其中一條把 README bash 區塊裡的
tea-sdlc 指令逐行拿去真的執行（家目錄指向空的暫存，所以一個檔都不會寫），
失敗理由若是「這個指令／參數我不認得」就算 README 寫錯——這比用眼睛核對可靠。

議題 #30

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>

admin approved these changes 2026-09-17 07:14:55 +00:00

admin merged commit 9644b6a638 into master

2026-09-17 07:14:58 +00:00

admin deleted branch docs/npm-deploy-alignment/main

2026-09-17 07:14:58 +00:00

Sign in to join this conversation.

2 Participants

Notifications

Due Date

No due date set.

Dependencies

No dependencies set.

Reference: plugins/tea-sdlc#39