SuperAPI AI 工具集

openspec-schema-authoring

编程与开发

查看项目

更新于 10-16 06:19

技能介绍

用途:创建或定制 OpenSpec 工作流 schema。目标是在本仓库生成 openspec/schemas/<schema-name>/ 目录,内含 schema.yaml 和 templates/。

选择方式:全新 schema 用 init;基于已知工作流定制用 fork(优先推荐)。先可用 openspec schemas --json 查看可 fork 的 schema。

初始化:openspec schema init <schema-name>。常用参数:--description "..." 描述工作流;--artifacts "proposal,specs,design,tasks" 设置 artifact 标识;--default 设为项目默认;--no-default 跳过交互式默认提示。预期产出 schema.yaml 与 templates/。

派生:openspec schema fork <source> [new-schema-name]。来源可为仓库本地 schema 或 CLI 提供的内置上游 schema。预期产出同上。

编辑要点:确保 artifacts[].id 与预期工作流顺序一致;artifacts[].requires 与依赖一致;artifacts[].generates 与产物输出路径一致;每个 artifact 在 templates/ 下有对应模板文件。

校验(必需):openspec schema validate <schema-name>。它是 OpenSpec CLI 1.3.1 支持的 schema 质量闸门;不要使用 openspec schema review,该命令在此 CLI 中不可用。

排查:行为异常时用 openspec schema which <schema-name> 调试解析。

完成标准:schema 位于 openspec/schemas/<schema-name>/;schema.yaml 与 templates/ 同时存在;validate 通过。

约束:优先 fork 而非手工复制;schema 保持在仓库本地 openspec/schemas/ 下;未校验前不应视为完成。