SuperAPI AI 工具集

EARS Notation

写作与研究

查看项目

更新于 10-15 22:16

技能介绍

用途:在需求工程中按 EARS(Easy Approach to Requirements Syntax)语法编写无歧义、可测试的验收标准。

核心原则:每条验收标准都遵循含大写关键字的固定句式,关键字必须大写,包括 WHEN、THE、SHALL、IF、THEN、WHILE、WHERE。强制使用 SHALL,不得使用 should、must、will、can、may;系统一律写成 THE [System],不得用小写 the system。表述要具体、可验证,避免 appropriate、quickly、properly 等模糊词。

六种模式及关键字:

  1. 通用(始终成立):THE [System] SHALL [behavior],用于无前置条件的要求。
  2. 事件驱动:WHEN [event] THE [System] SHALL [response],用于特定触发导致的行为。
  3. 状态驱动:WHILE [state] THE [System] SHALL [behavior],用于条件持续成立期间的行为。
  4. 可选功能:WHERE [feature is present] THE [System] SHALL [behavior],用于依赖功能开关或配置的行为。
  5. 错误处理/非期望行为:IF [condition] THEN THE [System] SHALL [response],用于错误、边界与异常处理。
  6. 复杂(组合条件):WHILE [state] WHEN [event] THE [System] SHALL [response],用于状态与事件共同触发。

常见错误:应把 The system should... 改为 THE System SHALL...;把 When clicking... 补全为 WHEN the user clicks... THE System SHALL...;把 Must validate... 改为 THE System SHALL validate...;把 Handle errors appropriately 改为 IF validation fails THEN THE System SHALL display...。

使用方式:可用校验脚本验证 EARS 语法,命令为 node scripts/ears-validator.js .specs/<feature>/requirements.md。资料还提到 references/patterns.md 与 examples/good-requirements.md 作为参考。

限制与暂未提供:资料未说明支持的平台、安装方式、收费或价格信息,暂未提供。