用途
openspec-onboard 是 OpenSpec 的引导式入门技能,目标是在用户真实代码库中完成一次完整的 OpenSpec 工作流周期,边做边讲,让用户理解每个环节的作用。它不是单纯罗列文档,而是安排一个真实的小任务走完全程。
主要能力
- 前置检查:先检测 OpenSpec CLI 是否安装(
openspec --version),未安装则提示先安装再回来使用 /opsx:onboard,并停止后续流程。 - 任务发现:扫描代码库中的 TODO/FIXME/HACK/XXX 注释、被吞掉的错误处理、缺少测试的函数、TypeScript 中的 any 类型、console.log/debugger 等调试残留、缺少校验的用户输入处理,并查看最近 git 提交记录(
git log --oneline -10)。 - 任务建议与范围护栏:呈现 3-4 个具体建议(含位置、规模估计与推荐理由);若用户选择过大的任务,会建议切片或另选,但尊重用户坚持。
- 探索演示:用 1-2 分钟阅读相关代码、必要时画 ASCII 图,演示探索模式(/opsx:explore)的思考方式。
- 创建变更:用
openspec new change "<derived-name>"创建openspec/changes/<name>/目录,包含 proposal.md、design.md、specs/、tasks.md。 - 逐件产出:依次起草提案(Why/What Changes/Capabilities/Impact)、规格(Requirement 与 WHEN/THEN/AND 场景)、设计(Context、Goals/Non-Goals、Decisions)、任务清单(复选框),关键节点暂停等待用户确认。
- 实现与归档:逐项实现任务并在 tasks.md 中勾选,最后用
openspec archive "<name>"归档到openspec/changes/archive/YYYY-MM-DD-<name>/。 - 收尾与命令速查:回顾八步流程,给出核心命令(/opsx:propose、/opsx:explore、/opsx:apply、/opsx:archive)与附加命令(/opsx:new、/opsx:continue、/opsx:ff、/opsx:verify)的速查表。
- 优雅退出:用户中途想停时,说明变更保存在
openspec/changes/<name>/,可日后用 /opsx:continue 或 /opsx:apply 恢复;用户只想看命令时直接给出速查表,不施压。
使用方式
在支持该技能的 AI 编码环境中调用 /opsx:onboard 触发。技能按“讲解→执行→展示→暂停”的节奏推进,在探索后、提案草稿后、任务清单后、归档后等关键节点等待用户确认。首次使用需自行安装 OpenSpec CLI。
适用场景
- 第一次接触 OpenSpec,想通过真实任务理解完整工作流;
- 团队新成员需要了解“探索→提案→规格→设计→任务→实现→归档”的节奏;
- 希望在真实代码库中顺手完成一个小改进,同时留下决策记录。
限制
- 依赖 OpenSpec CLI,未安装则无法继续;
- 设计为一次约 15-20 分钟的入门演练,不适合承载大型功能开发;
- 需要可读写的真实代码库,不使用模拟示例;
- 具体命令参数与应用行为以 OpenSpec 官方文档为准,资料未提供更多平台兼容性或收费信息。