SuperAPI AI 工具集

speckit-specify

编程与开发

查看项目

更新于 10-24 11:10

技能介绍

speckit-specify 是 Spec Kit 工作流中的规格编写命令,用途是把用户输入的自然语言功能描述转换为结构化、可评审的功能规格(spec)。

主要能力:

  • 从功能描述中提炼关键概念,包括参与者、动作、数据与约束。
  • 生成 2-4 个词的功能短名,尽量采用“动作-名词”形式,保留技术术语与缩写。
  • 创建功能规格目录与 spec.md 文件;目录默认位于 specs/ 下,编号可采用顺序编号(如 003-user-auth)或时间戳前缀,取决于 .specify/init-options.json 中的 branch_numbering 配置。
  • 按规格模板填写用户场景与测试、功能需求、成功标准、关键实体等章节;需求要求可测试,成功标准要求可度量且不涉及实现技术。
  • 对不明确之处最多保留 3 个 [NEEDS CLARIFICATION] 标记,并向用户提供选项表以确认。
  • 生成质量检查清单 specs 目录下的 checklists/requirements.md,从内容质量、需求完整性、功能就绪度三方面校验规格,并在最多 3 轮迭代内修正问题。
  • 支持扩展钩子:执行前读取 .specify/extensions.yml 中的 hooks.before_specify,执行后处理 hooks.after_specify;可选钩子仅提示命令,强制钩子输出 EXECUTE_COMMAND 并等待结果。
  • 将解析后的功能目录路径写入 .specify/feature.json,供 /speckit-plan、/speckit-tasks 等后续命令使用。

使用方式:在触发消息中通过 /speckit-specify 后附功能描述调用;命令会读取描述、按模板生成规格并写入文件,然后运行质量校验,必要时向用户提出最多 3 个澄清问题并等待回答。完成后报告功能目录、规格文件路径与检查清单结果。

适用场景:在编码前需要把产品想法整理成面向业务相关方的、技术无关的功能规格;需要与后续规划、任务拆分命令衔接的规约驱动开发流程。

限制:每次调用只创建一个功能;规格中不得包含实现细节(语言、框架、API),也不得嵌入检查清单;澄清问题最多 3 个;无法确定用户场景时报错终止;钩子条件表达式不在此命令内求值,交由 HookExecutor 实现。