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

Closed
opened 2026-09-17 06:00:35 +00:00 by jiantw83 · 1 comment
Member

母議題

#25 — 以 npm 佈署並提供 tea-sdlc 指令

要做出什麼

文件對齊現況。README 的安裝段目前把七套 marketplace 流程並列為建議路徑,但 skills/ 是空的——照那些流程裝完不會出現任何指令,並列等於在說謊。改成以 npm 為唯一建議路徑,七套流程移入附錄「其他安裝方式」保留而不刪除:那些機制本身有用(自動更新、plugin 清單),等 skills/ 有內容時會回來。

同時補上 prompt 與 status 的說明:前者是 agent 取得流程正本的管道,後者是使用者查安裝與環境現況的入口。

AGENTS.md 的模組邊界表新增指令入口那一列:職責是子指令解析與 dispatch,邊界是不含任何平台目錄知識與動作實作。

更新與移除的完整指令表不在這張票——「移除要先跑 tea-sdlc uninstall 再 npm rm -g」這句在 #17 完成前是假的。文件描述現況,議題描述意圖。

驗收標準

  • README 安裝段以 npm 為唯一建議路徑,含完整可複製的 git URL 安裝指令
  • 既有七套 marketplace 流程移入附錄「其他安裝方式」,內容未刪除
  • README 新增 prompt 與 status 的用途與用法說明
  • AGENTS.md 模組邊界表新增指令入口一列,職責與邊界皆已載明
  • README 不出現尚未實作的更新/移除指令表
  • 文件中的指令可逐字複製執行

阻擋於

  • #29 — 以 status 子指令回報安裝與環境現況
## 母議題 #25 — 以 npm 佈署並提供 tea-sdlc 指令 ## 要做出什麼 文件對齊現況。README 的安裝段目前把七套 marketplace 流程並列為建議路徑,但 `skills/` 是空的——照那些流程裝完不會出現任何指令,並列等於在說謊。改成以 npm 為唯一建議路徑,七套流程移入附錄「其他安裝方式」保留而不刪除:那些機制本身有用(自動更新、plugin 清單),等 `skills/` 有內容時會回來。 同時補上 `prompt` 與 `status` 的說明:前者是 agent 取得流程正本的管道,後者是使用者查安裝與環境現況的入口。 `AGENTS.md` 的模組邊界表新增指令入口那一列:職責是子指令解析與 dispatch,邊界是不含任何平台目錄知識與動作實作。 更新與移除的完整指令表**不在這張票**——「移除要先跑 `tea-sdlc uninstall` 再 `npm rm -g`」這句在 #17 完成前是假的。文件描述現況,議題描述意圖。 ## 驗收標準 - [x] README 安裝段以 npm 為唯一建議路徑,含完整可複製的 git URL 安裝指令 - [x] 既有七套 marketplace 流程移入附錄「其他安裝方式」,內容未刪除 - [x] README 新增 `prompt` 與 `status` 的用途與用法說明 - [x] `AGENTS.md` 模組邊界表新增指令入口一列,職責與邊界皆已載明 - [x] README 不出現尚未實作的更新/移除指令表 - [x] 文件中的指令可逐字複製執行 ## 阻擋於 - #29 — 以 status 子指令回報安裝與環境現況
jiantw83 added the ready-for-agent label 2026-09-17 06:00:35 +00:00
jiantw83 added a new dependency 2026-09-17 06:00:36 +00:00
Author
Member

已交付:前四條隨 #17 於 #36 合併,其餘落差與測試覆蓋於 #39(merge commit 9644b6a)補上。

關於「README 不出現尚未實作的更新/移除指令表」:該條寫於 #17 完成之前,當時「移除要先跑 tea-sdlc uninstall 再 npm rm -g」確實是假的。#17 已合併,該指令表描述的全部是已實作的行為,故視為達成。

關於「文件中的指令可逐字複製執行」:已改成由測試驗證,而非人工核對。test/readme-install.test.js 會把 README bash 區塊裡的 tea-sdlc 指令逐行真的執行(家目錄指向空的暫存目錄,因此不會寫入任何檔案),失敗理由若是 UNKNOWN_SUBCOMMAND / UNKNOWN_FLAG / MISSING_FLAG 即視為 README 寫錯。

已交付:前四條隨 #17 於 #36 合併,其餘落差與測試覆蓋於 #39(merge commit `9644b6a`)補上。 **關於「README 不出現尚未實作的更新/移除指令表」**:該條寫於 #17 完成之前,當時「移除要先跑 `tea-sdlc uninstall` 再 `npm rm -g`」確實是假的。#17 已合併,該指令表描述的全部是已實作的行為,故視為達成。 **關於「文件中的指令可逐字複製執行」**:已改成由測試驗證,而非人工核對。`test/readme-install.test.js` 會把 README bash 區塊裡的 `tea-sdlc` 指令逐行真的執行(家目錄指向空的暫存目錄,因此不會寫入任何檔案),失敗理由若是 `UNKNOWN_SUBCOMMAND` / `UNKNOWN_FLAG` / `MISSING_FLAG` 即視為 README 寫錯。
Sign in to join this conversation.
1 Participants
Notifications
Due Date
No due date set.
Reference: plugins/tea-sdlc#30