功能规格说明Skill

字段表、业务规则、状态流转、异常场景的功能规格写法。当需要把功能需求细化到字段级、可开发可测试的规格说明时使用。

Sky-Cube f1bb133 2.4 KB Updated

File contents

功能规格说明Skill

适用场景

PRD 中的功能条目需要进一步细化到开发可直接实现、测试可直接写用例的颗粒度:字段定义、规则、状态、异常全部穷尽。

执行步骤

  1. 识别规格对象:该功能涉及哪些实体(订单/用户/工单),每个实体一张字段表。
  2. 写字段表:字段名、类型、长度、必填性、默认值、取值范围/枚举、校验规则、是否脱敏。
  3. 写业务规则:每条规则编号(如 BR-01),写「条件 → 动作/结果」,标注规则间冲突与优先级。
  4. 画状态流转:列出全部状态、触发事件、前置条件、事件后的动作(通知/计数/落库)。
  5. 穷举异常场景:入参非法、并发冲突、超时、权限不足、数据不存在、重复提交,每条给处理方式与提示语。
  6. 关联验收标准:每条规格挂接 AC 编号,保证规格可被验收覆盖。

规范要点

  • 字段表禁止「见原型」「灵活配置」等不可执行表述,枚举值必须穷尽列出。
  • 业务规则用编号管理:规则被引用、被修改时按编号留痕,规则冲突必须显式声明优先级。
  • 状态流转用文字版状态机:状态列表 + 事件 + 前置条件 + 副作用四要素齐全,非法流转要标注「禁止并提示」。
  • 异常场景是规格的一部分,不是补充:默认值、空值、边界值、超长输入都要写清处理方式。
  • 金额、时间等敏感字段注明精度与单位(如「金额单位:分,精度整数」),避免口径歧义。

输出模板

# [功能名] 功能规格说明
1. 实体字段表(字段/类型/必填/默认值/范围/校验/脱敏)
2. 业务规则清单(BR-xx:条件 → 动作,含优先级)
3. 状态流转表(状态 × 事件 × 前置条件 × 副作用)
4. 异常场景处理表(场景/触发条件/处理/提示语)
5. 关联 AC 编号映射

自检清单

  • 枚举值穷尽,无"灵活配置"类表述
  • 规则有编号,冲突已声明优先级
  • 状态机四要素齐全,非法流转已标注
  • 异常场景覆盖:非法入参/并发/超时/权限/重复提交
  • 金额/时间等字段单位精度明确
  • 每条规格可回溯到 AC 编号

Sky-Cube/fullflow-dev-agent/tree/main/.claude/skills/functional-spec commit f1bb1338cd

Frequently asked questions

npx skillmds@latest add sky-cube/skill-16