From daf49bdd28f4ebca8d93ba002c8d1b4783fea002 Mon Sep 17 00:00:00 2001 From: Jeffery Date: Fri, 21 Aug 2026 13:08:43 +0800 Subject: [PATCH] =?UTF-8?q?docs(sdlc):=20=E4=BB=A5=E7=B5=B1=E4=B8=80?= =?UTF-8?q?=E6=A0=BC=E5=BC=8F=E6=94=B9=E5=AF=AB=E7=B9=81=E9=AB=94=E4=B8=AD?= =?UTF-8?q?=E6=96=87=20README=20=E8=88=87=20AGENTS?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-Authored-By: Claude Fable 5 --- AGENTS.md | 20 ++--- README.md | 248 +++++++++--------------------------------------------- 2 files changed, 49 insertions(+), 219 deletions(-) diff --git a/AGENTS.md b/AGENTS.md index a86a1f1..fbf6cef 100644 --- a/AGENTS.md +++ b/AGENTS.md @@ -1,15 +1,15 @@ -# jsc-template — 共用 Skills（跨 AI 助理） +# jsc-sdlc — 給 AI 助理的指引 -本 repo 是一組以 **Agent Skills（`SKILL.md`）** 標準撰寫的共用 skills，可同時被 Claude Code、Codex、Antigravity、OpenCode 使用。 +本 repo 是 jsc 技能組的 `sdlc` domain（開發生命週期：規劃/分析/實作/維護（wiki 追蹤）），可同時被 Claude Code / Codex / Copilot / Antigravity / Kiro 使用。 -## 給 AI 助理的指引 +## 規則 -- 所有可用的 skills 位於本 repo 的 `skills//SKILL.md`。 -- 在處理任務前，先比對使用者需求與各 skill `SKILL.md` frontmatter 的 `description`，若相符請載入並依其步驟執行。 -- **呼叫慣例**：在 Claude Code 與 Antigravity 中，這些 skill 以 `/jsc-template:` 呼叫；Codex 以 `$`、OpenCode 由模型依描述自動觸發 — 兩者沒有 `/jsc-template:` 前綴，不需強制加。 -- 完整清單與每個 skill 的用途，請見 `README.md` 的「Skills 目錄」。 +1. 所有交談與輸出內容基於 STE100 使用繁體中文：短句、一句一指令、主動語態、術語一致、UTF-8 無亂碼。 +2. 技能位於 `skills/{name}/SKILL.md`；處理任務前先比對需求與各技能的 `description`，相符就載入並依其步驟執行。 +3. 技能準則的唯一來源：`plugins/meta` 存取庫的 `references/guidelines.md`。 +4. 所有 hook 只放在 `jsc-hooks`；gitea 操作一律經由 `jsc-gitea` 的 `tools/gitea.sh`；問使用者一律依 `jsc-ask:ask` 的決策樹規則。 +5. 主 agent 不需要處理細節的流程，一律建立 sub agent 處理。 -## 慣例 +## 呼叫慣例 -- 新增 skill 一律放在 `skills//`，且 `` 使用小寫與連字號。 -- `description` 要寫清楚觸發條件（何時用、何時不用），這是跨助理自動載入的唯一依據。 +Claude Code / Antigravity：`/jsc-sdlc:{name}`；Codex：`$name`；Copilot / Kiro / OpenCode：描述需求自動觸發。 diff --git a/README.md b/README.md index 6c6669e..bbf6d7c 100644 --- a/README.md +++ b/README.md @@ -1,228 +1,58 @@ -# jsc-template — 跨 AI 助理 Plugin 模板 +# jsc-sdlc — 開發生命週期 -一個可同時被 **Claude Code、Codex、Antigravity、OpenCode、GitHub Copilot** 安裝的 plugin 模板。 -核心是以 [Agent Skills（`SKILL.md`）](https://agentskills.io) 標準撰寫的共用 skills（唯一真實來源放在 `skills/`）， -搭配各助理各自的 plugin manifest，讓**同一個 repo** 可用各家**原生 plugin CLI** 安裝。 -在 Claude Code 與 Antigravity 中，skill 以 **`/jsc-template:` 前綴**呼叫（例如 `/jsc-template:hello`）。 +jsc 技能組的 sdlc domain：規劃 → 分析 → 實作 → 維護四個階段，全程以 wiki 頁追蹤（`PLAN_*`、`ANALYZE_*`、`REPO_*`、`MAINTAIN_CONTENTS`）。每階段先做模型能力檢查，不適合就阻擋流程。 ---- - -## 前綴與呼叫方式 - -| 助理 | 安裝方式 | 呼叫 | `/jsc-template:` 前綴 | -| --- | --- | --- | --- | -| Claude Code | `claude plugin`（marketplace） | `/jsc-template:` 或自動觸發 | ✅ | -| Codex | `codex plugin`（marketplace） | `$` 或 `/skills` 選單 | ❌（用 `$name`） | -| Antigravity | `agy plugin install` | `/jsc-template:` 或自動觸發 | ✅ | -| OpenCode | skills 目錄（複製/clone） | 描述需求自動觸發 | ❌（依名稱） | -| GitHub Copilot CLI | `copilot plugin`（marketplace） | 自然語言或 plugin skills | ❌（無 `/jsc-template:` 前綴） | - -> Codex 不支援自訂前綴（skill 以 `$name` 呼叫）；OpenCode 由模型依描述自動呼叫；Copilot CLI 透過原生 plugin 安裝後以自然語言或 plugin skills 使用。三者皆**不強制**前綴。 - ---- - -## 目錄結構 - -同一個 repo 同時帶四種 manifest，彼此以路徑隔離、互不干擾；各助理都讀同一份 `skills/`。 - -``` -template/ -├── .claude-plugin/ -│ ├── plugin.json # Claude 外掛定義（name: "jsc-template"） -│ └── marketplace.json # Claude marketplace（name: "template"，source 指向本 repo） -├── .codex-plugin/ -│ └── plugin.json # Codex 外掛定義（name: "jsc-template"，skills: "./skills"） -├── .agents/plugins/ -│ └── marketplace.json # Codex marketplace（name: "template"，url source 指向本 repo） -├── plugin.json # Antigravity 外掛定義（name: "jsc-template"，skills: "./skills/"） -├── skills/ # ★ 唯一真實來源：所有 skills -│ └── hello/SKILL.md -├── AGENTS.md # 跨助理共用指引 -└── README.md -``` - ---- - -## 安裝 / 更新 / 移除（各助理） - -> 指令中的 repo 網址換成你的：`https://gitea.jsc.idv.tw/plugins/template.git` -> -> **Claude / Codex 從 git URL 安裝（會 clone 遠端），請先把本 repo `push` 到 gitea。** -> **Antigravity 的 `agy plugin install ` 目前只支援 github.com**；gitea 請改用「clone + 本地路徑」（見 Antigravity 節）。 -> 本機/離線：Claude 可用本地路徑加 marketplace；Antigravity 用本地路徑安裝。 - -> **⚠ 從 0.0.1 升上來的人請先移除再安裝。** 0.0.2 起 marketplace 名由 `jsc-plugins` 改為 `template` -> （舊名與 `jsc-persona` 的 marketplace 撞名）。各助理以 `@` 當安裝識別鍵， -> 改名後是兩筆獨立條目，**不能用 update 遷移**： -> -> ```bash -> claude plugin uninstall jsc-template@jsc-plugins -> claude plugin marketplace remove jsc-plugins # 若你沒有裝 jsc-persona 才移除，它也用這個名字 -> claude plugin marketplace add https://gitea.jsc.idv.tw/plugins/template.git -> claude plugin install jsc-template@template -> ``` -> -> 移除後記得清掉 `~/.claude/settings.json` 裡 `enabledPlugins` 的舊鍵 `jsc-template@jsc-plugins`， -> 並重開工作階段。Codex／Copilot 同理（`remove`／`uninstall` 後重新 `add`＋`install`）。 - -### Claude Code +## 安裝 ```bash -# 安裝 -claude plugin marketplace add https://gitea.jsc.idv.tw/plugins/template.git -claude plugin install jsc-template@template - -# 更新 -claude plugin marketplace update template -claude plugin update jsc-template@template - -# 移除 -claude plugin uninstall jsc-template@template -claude plugin marketplace remove template +claude plugin marketplace add https://gitea.jsc.idv.tw/plugins/sdlc.git +claude plugin install jsc-sdlc@sdlc ``` -- 工作階段內 slash 版（等價）：把 `claude plugin` 換成 `/plugin`。 -- 本機開發（免 push）：`claude plugin marketplace add C:\Users\h3285\source\repos.plugins\template`（本地路徑）後再 install。 -- **呼叫**：`/jsc-template:`（例 `/jsc-template:hello`）。 - -### Codex - -```bash -# 安裝 -codex plugin marketplace add https://gitea.jsc.idv.tw/plugins/template.git -codex plugin add jsc-template@template - -# 更新（重新抓取 marketplace 的 git 快照） -codex plugin marketplace upgrade template - -# 移除 -codex plugin remove jsc-template@template -codex plugin marketplace remove template -``` - -- 安裝 token `jsc-template@template` = plugin 名（`.codex-plugin/plugin.json` 的 `name`）@ marketplace 名（`.agents/plugins/marketplace.json` 的 `name`）。 -- 本 repo 的 Codex marketplace 以 `url` 來源指向自己，故 Codex **一律從 gitea 安裝**（需先 push）；安裝後重啟 Codex。 -- **呼叫**：`$`（例 `$hello`），或用 `/skills` 選單。 - -### Antigravity（`agy`） - -> `agy plugin install ` 目前**只支援 github.com**；gitea 等自架 git 不支援 URL 安裝，請先 `git clone` 再用**本地路徑**安裝。 - -```bash -# 安裝：clone 後用本地路徑 -git clone https://gitea.jsc.idv.tw/plugins/template.git ~/plugins/template -agy plugin install ~/plugins/template - -# 更新（agy 無 update 子指令 → git pull 後重裝） -git -C ~/plugins/template pull -agy plugin uninstall jsc-template -agy plugin install ~/plugins/template - -# 移除 -agy plugin uninstall jsc-template -``` - -- 若把 skills 放到 GitHub，則可直接 `agy plugin install https://github.com//`。 -- 其他：`agy plugin list`、`agy plugin enable jsc-template` / `disable jsc-template`、`agy plugin validate `。安裝後重啟工作階段。 -- **呼叫**：`/jsc-template:`（例 `/jsc-template:hello`）或依描述自動觸發。 - -### OpenCode - -OpenCode 的「plugin」是 TypeScript/npm 套件，不適用於 skill 包；skills 改用**目錄安裝**。 -OpenCode 會讀 `~/.config/opencode/skills/`（也會讀 `~/.claude/skills/`、`~/.agents/skills/`）。 - -```bash -# 安裝 -git clone https://gitea.jsc.idv.tw/plugins/template.git ~/plugins/template -mkdir -p ~/.config/opencode/skills -cp -r ~/plugins/template/skills/* ~/.config/opencode/skills/ - -# 更新 -git -C ~/plugins/template pull -cp -r ~/plugins/template/skills/* ~/.config/opencode/skills/ - -# 移除 -rm -rf ~/.config/opencode/skills/hello -``` - -> **Windows PowerShell**：`cp -r A B` → `Copy-Item A B -Recurse -Force`、`rm -rf X` → `Remove-Item X -Recurse -Force`、`~` → `$HOME`。 - -- **呼叫**：直接描述需求，模型會依 skill 描述自動透過 skill 工具呼叫。 - -### GitHub Copilot CLI - -Copilot CLI 支援與 Claude Code 類似的原生 plugin / marketplace 指令，可直接從 marketplace 安裝、更新與移除本 plugin。 - -```bash -# 安裝 -copilot plugin marketplace add https://gitea.jsc.idv.tw/plugins/template.git -copilot plugin install jsc-template@template - -# 更新 -copilot plugin marketplace update template -copilot plugin update jsc-template@template - -# 移除 -copilot plugin uninstall jsc-template@template -copilot plugin marketplace remove template -``` - -- 安裝 token `jsc-template@template` = plugin 名（plugin manifest 的 `name`）@ marketplace 名。 -- `copilot plugin marketplace add` 支援 GitHub `owner/repo`、git URL 與本地路徑；Gitea repo 可用上方 HTTPS URL。 -- **呼叫**：在 Copilot CLI 中用自然語言描述需求，例如 `copilot -i "跑 hello 確認 plugin 裝好了"`。 - ---- - -## 用 CLI 直接執行 skill（headless / 一次性） - -安裝好之後，不必進互動介面，一行指令就能叫某個 skill 跑完並印出結果： - -| 助理 | headless 指令 | 執行 `hello` skill | -| --- | --- | --- | -| Claude Code | `claude -p ""` | `claude -p "/jsc-template:hello"` | -| Codex | `codex exec ""` | `codex exec '$hello'` | -| Antigravity | `agy -p ""` | `agy -p "/jsc-template:hello"` | -| OpenCode | `opencode run ""` | `opencode run "用 hello skill 打個招呼"` | -| GitHub Copilot CLI | `copilot -p ""` | `copilot -p "用 hello skill 打個招呼"` | - -- Claude / Antigravity 支援 `/jsc-template:` 前綴，直接 `-p "/jsc-template:"` 即可。 -- Codex 以 `$` 觸發；在 shell 請用**單引號**避免 `$` 被展開：`codex exec '$hello'`。 -- OpenCode 與 Copilot 沒有前綴，用自然語言描述需求；Copilot CLI 會讀取已安裝 plugin 提供的 skills。 -- 帶引數就接在後面，例如 `claude -p "/jsc-template:hello 參數"`、`codex exec '$hello 參數'`。 - ---- +其他 CLI（codex / copilot / antigravity / kiro）與批次安裝、更新、解除安裝：使用 `/jsc-cli:deploy`。 ## Skills 目錄 -> 此區塊列出本 plugin 內含的所有 skills（名稱／描述／使用方法）。 -> 新增或修改 skill 後，請同步手動更新標記之間的內容。 +呼叫方式：Claude / Antigravity `/jsc-sdlc:{name}`；Codex `${name}`；Copilot / Kiro 描述需求自動觸發。 -### `hello` +### `plan` -範例 skill，用來驗證 jsc plugin 是否安裝成功，也是新增 skill 的範本。當使用者輸入 hello、想測試 plugin、或想看 skill 模板長什麼樣子時觸發；回覆一句問候並簡述此 plugin 的用途。 +規劃：讀計畫目錄 → 補充或新建計畫 → 決策樹補全目標 / 範圍 / 可行性至共識 → 產生使用者故事 → 寫回 `PLAN_{yyyyMMdd}_{HHmmss}_{HASH}`。純邏輯，禁止程式碼與修改檔案。 -- **Claude Code / Antigravity**：`/jsc-template:hello` -- **Codex**：`$hello`，或用 `/skills` 選單 -- **OpenCode / GitHub Copilot CLI**：描述需求自動觸發 +### `analyze` + +分析：搭配現況（工作目錄 + `REPO_{HASH}` 盤點複用）分析使用者故事 → WBS 產生編號工作包 → CPM 估工時與天數 → TDD 拆待辦 → 寫回 `ANALYZE_{yyyyMMdd}_{HHmmss}_{HASH}`。純邏輯，禁止程式碼與修改檔案。 + +### `implement` + +實作：產生工作證鎖定「未完成、無相依、無工作證」的工作包 → 逐項 TDD 實作、每完成一項立即更新 wiki → 程式碼審查 → 詢問是否加入維護目錄。 + +### `maintain` + +維護：讀取維護期內的專案，每個專案一個 sub agent：切 develop/master → 至少五種建議維護方法 → commit / push / PR → 更新前次維護時間。 ---- +## 範本與參考 -## 新增一個 skill +| 檔案 | 用途 | +| --- | --- | +| `templates/plan-page.md`、`templates/plan-contents.md` | 計畫頁與計畫目錄 | +| `templates/analyze-page.md`、`templates/analyze-contents.md` | 分析頁（WBS / CPM / TDD 待辦）與分析目錄 | +| `templates/repo-page.md`、`templates/repo-contents.md` | 存取庫盤點頁（功能與端點 + commit sha）與盤點目錄 | +| `templates/maintain-contents.md` | 維護目錄（截止日 NULL = 永久維護） | +| `references/tdd.md` | 接縫、紅綠循環規則、反模式 | -1. 複製範本：`cp -r skills/hello skills/` -2. 編輯 `skills//SKILL.md` 的 frontmatter： - - `name`：小寫、數字、連字號（`-`），最長 64 字元。**這就是 Claude Code / Antigravity 的 `/jsc-template:`**。 - - `description`：第三人稱，寫清楚「何時用、何時不用」與觸發關鍵字 — 這是各助理自動載入的唯一依據。 -3. 在內文寫下 skill 的具體步驟。 -4. 手動把這個 skill 補進上方「Skills 目錄」區塊。 -5. **bump 版本並 push**：各助理都以 git 內容/版本判斷更新，請把 `.claude-plugin/plugin.json`、`.codex-plugin/plugin.json`、`plugin.json` 三個 manifest 的 `version` 一起 bump，commit 後 push 到 gitea。 -6. 讓各助理更新： - - Claude：`claude plugin update jsc-template@template` - - Codex：`codex plugin marketplace upgrade template` - - Antigravity：`git -C ~/jsc-plugin pull && agy plugin uninstall jsc-template && agy plugin install ~/jsc-plugin` - - OpenCode：`git pull` 後重新複製 `skills/` - - Copilot：`copilot plugin marketplace update template && copilot plugin update jsc-template@template` +## 環境變數 + +Wiki 位置：`JSC_WIKI_REPO_PLAN` / `JSC_WIKI_REPO_ANALYZE` / `JSC_WIKI_REPO_REPO` / `JSC_WIKI_REPO_MAINTAIN`，未設定退回 `JSC_WIKI_REPO`，再未設定就詢問（見 `jsc-gitea`）。 + +## 相關 domain + +- `jsc-cli`：模型能力標籤（`jsc-cli:models`） +- `jsc-gitea`：wiki 讀寫 +- `jsc-review`：實作完成後的程式碼審查 +- `jsc-git` / `jsc-pkg`：維護階段的 commit / PR 與套件更新 +- `jsc-log`：完工後的工作日誌