add README guidance to skill workflow
This commit is contained in:
@@ -0,0 +1,67 @@
|
||||
# skiff
|
||||
|
||||
`skiff` 用于创建、维护、安装和发布团队自研的 Agent Skill。Skill 的唯一来源位于
|
||||
`~/.skills/skills/<name>/`,安装到各 Agent 时使用软链接。
|
||||
|
||||
## 什么时候使用
|
||||
|
||||
- 想把项目里的重复工作沉淀成一个 skill。
|
||||
- 想完善、校验、转正或发布已有 skill。
|
||||
- 想把自研 skill 安装到当前项目或全局 Agent。
|
||||
- 想检查并修复 skill 软链接。
|
||||
|
||||
## 创建一个 skill
|
||||
|
||||
```bash
|
||||
skiff create my-skill \
|
||||
--idea "描述这个 skill 要解决的重复问题" \
|
||||
--from-project .
|
||||
```
|
||||
|
||||
命令会在 `~/.skills/.drafts/my-skill/` 创建:
|
||||
|
||||
- `SKILL.md`:给 Agent 阅读的工作流与约束。
|
||||
- `README.md`:给人类阅读的用途、准备事项、示例和完成标准。
|
||||
- `brief.yaml`:草稿来源信息,转正时自动移除。
|
||||
|
||||
完善 `SKILL.md` 和 `README.md` 后运行:
|
||||
|
||||
```bash
|
||||
skiff check my-skill
|
||||
skiff finalize my-skill
|
||||
```
|
||||
|
||||
## 提交和发布
|
||||
|
||||
只提交:
|
||||
|
||||
```bash
|
||||
skiff publish skills/my-skill -m "add my-skill"
|
||||
```
|
||||
|
||||
提交并推送:
|
||||
|
||||
```bash
|
||||
skiff publish skills/my-skill -m "add my-skill" --push
|
||||
```
|
||||
|
||||
## 安装
|
||||
|
||||
安装到当前项目的 Codex:
|
||||
|
||||
```bash
|
||||
skiff add my-skill -a codex -y
|
||||
```
|
||||
|
||||
安装到全局 Codex:
|
||||
|
||||
```bash
|
||||
skiff add my-skill -a codex -g -y
|
||||
```
|
||||
|
||||
## 如何判断完成
|
||||
|
||||
- `skiff check <name>` 输出校验通过。
|
||||
- 正式 skill 同时包含 `SKILL.md` 和 `README.md`。
|
||||
- `skiff status` 或 `skiff doctor` 显示目标软链接正常。
|
||||
|
||||
@@ -38,15 +38,16 @@ skiff add <name> -a cursor -a claude -a codex -y
|
||||
skiff create <name> --idea "<用户原始想法>" --from-project .
|
||||
```
|
||||
|
||||
4. 编辑 `~/.skills/.drafts/<name>/SKILL.md`,完善触发条件、不适用场景、步骤、边界与验证方法。仅在确有必要时增加 `references/`、`scripts/` 或 `assets/`。
|
||||
5. 不要把项目专属路径、私有业务规则、一次性命令或密钥复制到通用 skill。
|
||||
6. 运行校验并修复所有问题:
|
||||
4. 编辑 `~/.skills/.drafts/<name>/SKILL.md`,完善触发条件、不适用场景、步骤、边界与验证方法。
|
||||
5. 编辑同目录的 `README.md`,用面向人类的语言说明用途、准备事项、可直接复制的请求示例、Agent 会做什么以及如何判断完成。README 不应复述 Agent 内部指令。
|
||||
6. 仅在确有必要时增加 `references/`、`scripts/` 或 `assets/`。不要把项目专属路径、私有业务规则、一次性命令或密钥复制到通用 skill。
|
||||
7. 运行校验并修复所有问题:
|
||||
|
||||
```bash
|
||||
skiff check <name>
|
||||
```
|
||||
|
||||
7. 向用户展示名称、description、核心步骤和验证方式。获得确认后再转正:
|
||||
8. 向用户展示名称、description、README 的人类使用方式、核心步骤和验证方式。获得确认后再转正:
|
||||
|
||||
```bash
|
||||
skiff finalize <name>
|
||||
|
||||
Reference in New Issue
Block a user