SuperAPI AI 工具集

requirements

通用与其它

查看项目

更新于 10-16 07:14

技能介绍

用途:在实现之前澄清复杂功能的需求。产出的需求文档是思考工具而非长期事实来源,功能落地后由代码取代。它只定义“要做什么”;“如何规划实现”参见 /code-planning,“领域建模决策”参见 /domain-design 第 10 节,端到端流程可查看项目的 CLAUDE.md。

适用场景:新增领域实体或聚合、多个新端点协同、需要命名与界定边界的新领域概念、横切行为变更(如新权限模型、新币种支持)、边界情况不明显的功能。不适用:给已有表加列、给已有端点加排序/筛选、有明确复现步骤的缺陷修复、已有实体的简单 CRUD 扩展。

主要能力与 EARS 记法:EARS(Easy Approach to Requirements Syntax)产出无歧义、可测试的需求,含五种模式:通用型(始终成立,用 shall)、事件驱动型(用 When)、状态驱动型(用 While)、条件型(用 If...then)、复合型(组合多种)。

输出格式:调用 /requirements 时产出四部分。1)验收标准:用 EARS 记法列出需求,按功能领域分组,每条可独立测试。2)实体草稿:新实体的名称、关键字段、关系、聚合边界,只需够验证领域模型,不用完整 schema(示例含 id、name、kind 枚举、currency、value 等字段说明)。3)边界情况:列举易忽略场景,如边界值、并发访问、缺失/空状态、货币边界(同值不同币是否相等)、分页边界。4)待决问题:列出实现前需决定的事项,并标注应由领域专家、技术负责人还是设计师回答。

需求存放位置:PR 描述(验收标准写在 PR 正文,不用单独 spec 文件)、GitHub issue(若功能需要先讨论,需求写在 issue 正文)。不要长期 spec 文件,不建 docs/specs/ 目录,不做版本化需求文档。

限制:资料未提供该技能的具体安装方式、收费、平台支持或其他功能细节。