SuperAPI AI 工具集

openspec-onboard

办公与效率

查看项目

更新于 10-16 00:22

技能介绍

用途:带用户完成第一次完整的 OpenSpec 工作流循环。这是一个教学型流程,会在用户真实代码库中做实际改动,并逐步解释每一步;资料称约 15-20 分钟。

前置检查:先检查 OpenSpec CLI 是否安装。 Unix/macOS:openspec --version 2>&1 || echo "CLI_NOT_INSTALLED" Windows(PowerShell)可用 Get-Command openspec 判断。未安装则停止并提示先安装,再回到 /opsx:onboard。

主要阶段:

  1. 欢迎,说明将完成从想法到实现的完整变更循环。
  2. 任务选择:扫描代码库找小改进点(TODO/FIXME/HACK/XXX 注释、吞掉错误的 catch、无测试的函数、TypeScript 的 any、调试语句、缺少输入校验),并查看 git 历史(git log --oneline -10)。给出 3-4 个具体建议;若范围过大则建议切小,用户坚持可覆盖。
  3. 探索演示:用约 1-2 分钟读相关代码,演示 /opsx:explore 的思考方式。
  4. 创建变更:openspec new change "<derived-name>",生成 openspec/changes/<name>/ 及 proposal.md、design.md、specs/、tasks.md。
  5. 提案:说明为什么做,生成草稿并获得确认后保存。可用 openspec instructions proposal --change "<name>" --json。
  6. 规格:用 ADDED Requirements 与 Requirement/Scenario 的 WHEN/THEN/AND 格式写可测试需求,保存到 specs/<capability>/spec.md。
  7. 设计:记录背景、目标/非目标、关键决策,保存 design.md。
  8. 任务:把工作拆成带复选框的清单,保存 tasks.md。
  9. 实现:逐项完成任务,在 tasks.md 里勾选,并自然引用规格与设计。
  10. 归档:openspec archive "<name>",移动到 openspec/changes/archive/YYYY-MM-DD-<name>/。
  11. 回顾与命令参考。

相关命令:核心流程为 /opsx:propose、/opsx:explore、/opsx:apply、/opsx:archive;另有 /opsx:new、/opsx:continue、/opsx:ff、/opsx:verify。中断可稍后用 /opsx:continue <name> 或 /opsx:apply <name> 恢复;只想看命令可直接给出速查表。

限制:需已安装 OpenSpec CLI,否则流程无法开始;流程要求使用真实代码库任务,不模拟或使用假例子;在关键节点暂停等待确认,但不宜过度暂停;实现阶段讲解从简;即使变小也应走完各阶段。未提供收费、价格、平台支持等信息。