feat(skills): add codex compatibility
This commit is contained in:
@@ -1,60 +1,78 @@
|
||||
# Spec Coding Skills
|
||||
|
||||
一套 Claude Code Skills,支持产品文档工作流的完整生命周期管理。
|
||||
一套同时支持 Claude Code 和 Codex 的 Skills,覆盖产品文档工作流的完整生命周期管理。
|
||||
|
||||
## 平台适配
|
||||
|
||||
| 平台 | 安装目录 | 触发方式 |
|
||||
|------|----------|----------|
|
||||
| Claude Code | `.claude/skills/` | `/rr`、`/wp`、`/go` 这类 slash commands |
|
||||
| Codex | `.codex/skills/` | `$rr`、`$wp`,或直接自然语言说明“用 rr skill 评审需求文档” |
|
||||
|
||||
> Codex 额外需要项目根目录存在 `AGENTS.md`。本仓库已提供 `AGENTS.md.template`,安装脚本在 Codex 模式下会自动生成。
|
||||
|
||||
## 功能概览
|
||||
|
||||
```
|
||||
RequirementsDoc ──▶ PRD ──▶ FeatureSummary ──▶ DevelopmentPlan ──▶ UIDesign ──▶ tasks
|
||||
│ │ │ │ │ │
|
||||
/rr /rp /rf /rd /ru /rt ← Review
|
||||
/mr /mp /mf /md /mu /mt ← Modify
|
||||
/wp /wf /wd /wu /wt ← Write
|
||||
rr rp rf rd ru rt ← Review
|
||||
mr mp mf md mu mt ← Modify
|
||||
wp wf wd wu wt ← Write
|
||||
```
|
||||
|
||||
### Skills 列表
|
||||
|
||||
| 类型 | 命令 | 描述 |
|
||||
|------|------|------|
|
||||
| **Review** | `/rr` | 评审 RequirementsDoc.md |
|
||||
| | `/rp` | 评审 PRD.md |
|
||||
| | `/rf` | 评审 FeatureSummary.md |
|
||||
| | `/rd` | 评审 DevelopmentPlan.md |
|
||||
| | `/ru` | 评审 UIDesign.md |
|
||||
| | `/rt` | 评审 tasks.md |
|
||||
| **Write** | `/wp` | 从 RequirementsDoc 生成 PRD |
|
||||
| | `/wf` | 从 PRD 生成 FeatureSummary |
|
||||
| | `/wd` | 从 FeatureSummary 生成 DevelopmentPlan |
|
||||
| | `/wu` | 从 DevelopmentPlan 生成 UIDesign |
|
||||
| | `/wt` | 从 DevelopmentPlan 生成 tasks |
|
||||
| **Modify** | `/mr` | 增量修改 RequirementsDoc |
|
||||
| | `/mp` | 增量修改 PRD(自动读取评审报告) |
|
||||
| | `/mf` | 增量修改 FeatureSummary |
|
||||
| | `/md` | 增量修改 DevelopmentPlan |
|
||||
| | `/mu` | 增量修改 UIDesign |
|
||||
| | `/mt` | 增量修改 tasks |
|
||||
| **执行** | `/go` | 🚀 发射按钮,激进模式一口气完成开发 |
|
||||
| **辅助** | `/iter` | 迭代变更入口(Bug/功能/重构) |
|
||||
| | `/up` | Skill 升级优化 |
|
||||
| | `/deploy` | Drone CI/CD 全流程部署引导 |
|
||||
| | `/changelog` | 一键发版(日志 + commit + tag) |
|
||||
| 类型 | Skill | Claude Code | Codex | 描述 |
|
||||
|------|-------|-------------|-------|------|
|
||||
| **Review** | `rr` | `/rr` | `$rr` | 评审 RequirementsDoc.md |
|
||||
| | `rp` | `/rp` | `$rp` | 评审 PRD.md |
|
||||
| | `rf` | `/rf` | `$rf` | 评审 FeatureSummary.md |
|
||||
| | `rd` | `/rd` | `$rd` | 评审 DevelopmentPlan.md |
|
||||
| | `ru` | `/ru` | `$ru` | 评审 UIDesign.md |
|
||||
| | `rt` | `/rt` | `$rt` | 评审 tasks.md |
|
||||
| **Write** | `wp` | `/wp` | `$wp` | 从 RequirementsDoc 生成 PRD |
|
||||
| | `wf` | `/wf` | `$wf` | 从 PRD 生成 FeatureSummary |
|
||||
| | `wd` | `/wd` | `$wd` | 从 FeatureSummary 生成 DevelopmentPlan |
|
||||
| | `wu` | `/wu` | `$wu` | 从 DevelopmentPlan 生成 UIDesign |
|
||||
| | `wt` | `/wt` | `$wt` | 从 DevelopmentPlan 生成 tasks |
|
||||
| **Modify** | `mr` | `/mr` | `$mr` | 增量修改 RequirementsDoc |
|
||||
| | `mp` | `/mp` | `$mp` | 增量修改 PRD(自动读取评审报告) |
|
||||
| | `mf` | `/mf` | `$mf` | 增量修改 FeatureSummary |
|
||||
| | `md` | `/md` | `$md` | 增量修改 DevelopmentPlan |
|
||||
| | `mu` | `/mu` | `$mu` | 增量修改 UIDesign |
|
||||
| | `mt` | `/mt` | `$mt` | 增量修改 tasks |
|
||||
| **执行** | `go` | `/go` | `$go` | 🚀 发射按钮,激进模式一口气完成开发 |
|
||||
| **辅助** | `iter` | `/iter` | `$iter` | 迭代变更入口(Bug/功能/重构) |
|
||||
| | `update` | `/up` | `$update` 或 `$up` | Skill 升级优化 |
|
||||
| | `deploy` | `/deploy` | `$deploy` | Drone CI/CD 全流程部署引导 |
|
||||
| | `changelog` | `/changelog` | `$changelog` | 一键发版(日志 + commit + tag) |
|
||||
|
||||
## 安装 & 更新
|
||||
|
||||
一行命令搞定安装和更新。脚本会智能处理:新 skill 直接装,已有的对比更新,本地魔改自动备份。
|
||||
|
||||
```bash
|
||||
# 在你的项目根目录执行(首次安装 & 后续更新都用这条)
|
||||
bash <(curl -sL https://git.internal.intelligrow.cn/zhangfucai/spec-coding-skills/raw/branch/main/install.sh)
|
||||
# Codex(默认)
|
||||
bash <(curl -sL https://git.internal.intelligrow.cn/zhangfucai/spec-coding-skills/raw/branch/main/install.sh) codex
|
||||
|
||||
# Claude Code
|
||||
bash <(curl -sL https://git.internal.intelligrow.cn/zhangfucai/spec-coding-skills/raw/branch/main/install.sh) claude
|
||||
```
|
||||
|
||||
或者先下载再执行:
|
||||
|
||||
```bash
|
||||
curl -sL https://git.internal.intelligrow.cn/zhangfucai/spec-coding-skills/raw/branch/main/install.sh -o /tmp/install-skills.sh
|
||||
bash /tmp/install-skills.sh
|
||||
bash /tmp/install-skills.sh codex
|
||||
```
|
||||
|
||||
### 安装脚本行为
|
||||
|
||||
- `codex` 模式:安装到 `.codex/skills/`,并在项目根目录生成或更新 `AGENTS.md`
|
||||
- `claude` 模式:安装到 `.claude/skills/`,并在项目根目录生成或更新 `CLAUDE.md`
|
||||
- 如果传入自定义目标目录,脚本会优先安装 Codex 版 skills;目标路径包含 `.claude/skills` 时自动切到 Claude 版
|
||||
|
||||
### 更新策略
|
||||
|
||||
| 情况 | 处理方式 |
|
||||
@@ -71,25 +89,48 @@ bash /tmp/install-skills.sh
|
||||
|
||||
### 0->1 阶段:从需求到开发
|
||||
|
||||
```bash
|
||||
# 1. 准备文档
|
||||
/wp # 生成 PRD
|
||||
/wf # 生成 FeatureSummary
|
||||
/wd # 生成 DevelopmentPlan
|
||||
/wt # 生成 tasks
|
||||
Claude Code:
|
||||
|
||||
# 2. 发射!
|
||||
/go # 激进模式,一口气完成所有任务
|
||||
```bash
|
||||
/wp
|
||||
/wf
|
||||
/wd
|
||||
/wt
|
||||
/go
|
||||
```
|
||||
|
||||
Codex:
|
||||
|
||||
```text
|
||||
$wp
|
||||
$wf
|
||||
$wd
|
||||
$wt
|
||||
$go
|
||||
```
|
||||
|
||||
### 1->100 阶段:持续迭代
|
||||
|
||||
```bash
|
||||
# 1. 描述变更需求
|
||||
/iter # 调研 → 澄清 → 更新 PRD 和 tasks
|
||||
Claude Code:
|
||||
|
||||
# 2. 执行变更
|
||||
/go # 自动识别新任务并执行
|
||||
```bash
|
||||
/iter
|
||||
/go
|
||||
```
|
||||
|
||||
Codex:
|
||||
|
||||
```text
|
||||
$iter
|
||||
$go
|
||||
```
|
||||
|
||||
也可以直接说自然语言,例如:
|
||||
|
||||
```text
|
||||
请用 rr skill 评审 doc/RequirementsDoc.md
|
||||
请用 wf skill 根据 PRD 生成 FeatureSummary
|
||||
请用 go skill 按 doc/tasks.md 执行未完成任务
|
||||
```
|
||||
|
||||
### 工作流总览
|
||||
@@ -98,12 +139,12 @@ bash /tmp/install-skills.sh
|
||||
┌─────────────────────────────────────────────────────────┐
|
||||
│ 0->1 全新项目 │
|
||||
│ │
|
||||
│ 需求 → /wp → /wf → /wd → /wt → /go 🚀 │
|
||||
│ 需求 → wp → wf → wd → wt → go 🚀 │
|
||||
│ │
|
||||
├─────────────────────────────────────────────────────────┤
|
||||
│ 1->100 持续迭代 │
|
||||
│ │
|
||||
│ 发现问题 → /iter → /go 🚀 │
|
||||
│ 发现问题 → iter → go 🚀 │
|
||||
│ │
|
||||
└─────────────────────────────────────────────────────────┘
|
||||
```
|
||||
@@ -122,8 +163,16 @@ bash /tmp/install-skills.sh
|
||||
|
||||
```
|
||||
your-project/
|
||||
├── AGENTS.md # ← Codex 项目入口(Codex 模式)
|
||||
├── CLAUDE.md # ← Claude Code 项目入口(Claude 模式)
|
||||
├── .codex/
|
||||
│ └── skills/ # ← Codex Skills 安装位置
|
||||
│ ├── rr/
|
||||
│ ├── rp/
|
||||
│ ├── ...
|
||||
│ └── iter/
|
||||
├── .claude/
|
||||
│ └── skills/ # ← Skills 安装位置
|
||||
│ └── skills/ # ← Claude Code Skills 安装位置
|
||||
│ ├── rr/
|
||||
│ ├── rp/
|
||||
│ ├── ...
|
||||
|
||||
Reference in New Issue
Block a user