SuperAPI AI 工具集

spec-workflow

编程与开发

查看项目

更新于 10-16 02:03

技能介绍

用途

Spec Workflow 用于结构化开发流程,在动手写代码之前先明确需求、技术设计与任务规划。它适合中大型变更,尤其是跨模块、涉及多文件、用户流程、数据库设计或 UI 设计,且验收边界模糊、需要分阶段确认的工作。

主要能力

该技能将开发过程划分为四个阶段:

  1. 需求阶段:创建 specs/<spec_name>/requirements.md,重述问题与范围,编写用户故事,以 EARS 风格编写验收标准,并澄清业务规则、约束与非目标。EARS 模式为:While <可选前置条件>, when <可选触发条件>, the <系统名称> shall <系统响应>。例如:When the user submits the form, the booking system shall validate required fields before creating the record.

  2. 设计阶段:创建 specs/<spec_name>/design.md,描述架构与模块边界,说明技术选择与权衡,按需定义数据模型、API、安全与测试策略。仅在图表能显著提升清晰度时使用 Mermaid。

  3. 任务阶段:创建 specs/<spec_name>/tasks.md,将设计拆解为可执行任务,保持任务具体且可审查,每个任务关联回相关需求,并随进展更新任务状态。任务格式示例:

Implementation Plan

  • [ ] 1. Task title
    • Specific work item
    • Another concrete step
    • _Requirement: 1
  1. 执行阶段:仅在用户确认任务计划后才开始实现。执行期间保持任务状态最新,一次完成一个有意义的单元,保持变更到任务再到需求的可追溯性。

使用方式

当请求属于新功能、多步骤产品变更、跨模块集成或架构/设计任务,或验收标准不清晰需要先明确时,应首先使用此技能。若不确定任务应直接编码还是先走需求、设计与任务规划,或请求提到新页面、新系统、重新设计、工作流或多模块重构,也应在写代码前阅读。若涉及前端页面或视觉设计,还需阅读 ../ui-design/SKILL.md;若涉及高级数据模型工作,还需阅读 ../data-model-creation/SKILL.md。

该技能为本地技能,同级 CloudBase 技能以本地相对路径提供,例如 ../auth-tool-cloudbase/SKILL.md。如果引用的同级技能文件在当前环境中缺失,应请用户安装完整的 CloudBase 插件或缺失的技能,不要通过 HTTP 将远程技能或协议 markdown 拉取到智能体上下文中。

适用场景

  • 定义或细化新功能
  • 设计复杂架构
  • 协调跨模块变更
  • 规划数据库或 UI 密集型工作
  • 提升需求质量与验收边界

限制

以下情况不应使用该技能:范围明确的小型缺陷修复、单文件文档更新、直接的配置变更、用户已给出精确实现指令的微小重构。

常见错误包括:在验收标准明确前就跳入编码;在需求、设计与任务之间跳过用户确认;编写无法映射回用户可见结果的模糊任务;将 UI 工作视为纯技术实现而不澄清设计意图。

最小检查清单:判断变更是否真的需要完整规格流程;若是,先停下来产出需求;若变更小、低风险且验收已明确,允许直接执行而不强制产出规格文档;使用 EARS 风格验收标准;在进入下一阶段前获得确认。

智能体工作规则:当请求描述不充分时应追问,不要猜测核心产品行为;在需求、设计与任务拆解之间要求确认;当变更包含终端用户页面或视觉决策时尽早引入 ui-design;保持文档简洁但可测试;优先使用用户可见结果而非实现细节作为任务名称。

输出预期:requirements.md 包含问题、范围、用户故事、EARS 验收标准;design.md 包含架构、技术方案、数据/API/安全/测试说明;tasks.md 为与需求关联的可执行实现清单。