Refactor plugin and README for documentation skills; add doc-docker and doc-funcs skills
This commit is contained in:
@@ -1,9 +1,10 @@
|
||||
# jsc — 跨 AI 助理 Plugin 模板
|
||||
# jsc — 跨 AI 助理文件化 Skill 集合
|
||||
|
||||
一個可同時被 **Claude Code、Codex、Antigravity、OpenCode** 安裝的 plugin 模板。
|
||||
一個可同時被 **Claude Code、Codex、Antigravity、OpenCode** 安裝的文件化 skill 集合。
|
||||
目前內含:對齊 docker-compose 行內註解(`doc-docker`)、為專案 function 補齊 XML 文件並更新 README 功能目錄(`doc-funcs`)。
|
||||
核心是以 [Agent Skills(`SKILL.md`)](https://agentskills.io) 標準撰寫的共用 skills(唯一真實來源放在 `skills/`),
|
||||
搭配各助理各自的 plugin manifest,讓**同一個 repo** 可用各家**原生 plugin CLI** 安裝。
|
||||
在 Claude Code 與 Antigravity 中,skill 以 **`/jsc:` 前綴**呼叫(例如 `/jsc:hello`)。
|
||||
在 Claude Code 與 Antigravity 中,skill 以 **`/jsc:` 前綴**呼叫(例如 `/jsc:doc-docker`)。
|
||||
|
||||
---
|
||||
|
||||
@@ -16,7 +17,7 @@
|
||||
| Antigravity | `agy plugin install` | `/jsc:<name>` 或自動觸發 | ✅ |
|
||||
| OpenCode | skills 目錄(複製/clone) | 描述需求自動觸發 | ❌(依名稱) |
|
||||
|
||||
> Codex 不支援自訂前綴(skill 以 `$name` 呼叫);OpenCode 由模型依描述自動呼叫。兩者皆**不強制**前綴。
|
||||
> Codex 不支援自訂前綴(skill 以 `$name` 呼叫,例 `$doc-docker`);OpenCode 由模型依描述自動呼叫。兩者皆**不強制**前綴。
|
||||
|
||||
---
|
||||
|
||||
@@ -25,7 +26,7 @@
|
||||
同一個 repo 同時帶四種 manifest,彼此以路徑隔離、互不干擾;四家都讀同一份 `skills/`。
|
||||
|
||||
```
|
||||
template/
|
||||
doc/
|
||||
├── .claude-plugin/
|
||||
│ ├── plugin.json # Claude 外掛定義(name: "jsc")
|
||||
│ └── marketplace.json # Claude marketplace(name: "jsc-plugins",source 指向本 repo)
|
||||
@@ -35,7 +36,10 @@ template/
|
||||
│ └── marketplace.json # Codex marketplace(name: "jsc-plugins",url source 指向本 repo)
|
||||
├── plugin.json # Antigravity 外掛定義(name: "jsc",skills: "./skills/")
|
||||
├── skills/ # ★ 唯一真實來源:所有 skills
|
||||
│ └── hello/SKILL.md
|
||||
│ ├── doc-docker/ # 對齊 docker-compose 註解(含 scripts/)
|
||||
│ │ ├── SKILL.md
|
||||
│ │ └── scripts/
|
||||
│ └── doc-funcs/SKILL.md # 為 function 補齊 XML 文件
|
||||
├── AGENTS.md # 跨助理共用指引
|
||||
└── README.md
|
||||
```
|
||||
@@ -169,6 +173,22 @@ rm -rf ~/.config/opencode/skills/hello
|
||||
- **Codex**:`$hello`,或用 `/skills` 選單
|
||||
- **OpenCode**:描述需求自動觸發
|
||||
|
||||
### `doc-docker`
|
||||
|
||||
整理並對齊 docker-compose.yaml 的行內註解與標題區塊。當使用者要對齊 docker-compose 註解、整理 compose 檔註解欄位、更新 compose 標題日期,或提到 docker-compose、dc-tidy、align_comments、註解對齊時使用此 skill。
|
||||
|
||||
- **Claude Code / Antigravity**:`/jsc:doc-docker`
|
||||
- **Codex**:`$doc-docker`,或用 `/skills` 選單
|
||||
- **OpenCode**:描述需求自動觸發
|
||||
|
||||
### `doc-funcs`
|
||||
|
||||
為目前專案的每個 function 建立 .docs/ 草稿並補齊 XML 文件,最後更新 README 功能目錄。當使用者要補齊 function 文件、產生 XML doc、為每個 method 加 summary/param/remarks、建立 .docs 草稿,或提到 doc-funcs、function 文件化、XML documentation comments 時使用此 skill。
|
||||
|
||||
- **Claude Code / Antigravity**:`/jsc:doc-funcs`
|
||||
- **Codex**:`$doc-funcs`,或用 `/skills` 選單
|
||||
- **OpenCode**:描述需求自動觸發
|
||||
|
||||
<!-- JSC-SKILLS:END -->
|
||||
|
||||
---
|
||||
|
||||
Reference in New Issue
Block a user