SuperAPI AI 工具集

spec-writer

写作与研究

查看项目

更新于 10-15 23:33

技能介绍

用途:spec-writer 用于编写功能规格说明,捕获需求与验收标准。它强调只描述 WHAT 和 WHY,不规定 HOW。适用于(1)编写新功能规格,(2)记录功能需求。

主要能力:调用时可接收参数,为 $ARGUMENTS 编写规格。工作流包括:从用户输入或参数中收集功能描述、目标用户、问题陈述和约束,对缺失信息提出澄清问题;创建 specs/feature-name/ 目录;将 assets/spec.md 复制为 specs/feature-name/README.md;完成必需章节;完成后按检查清单验证。

必需章节:功能概述(2-3 段:是什么、给谁、解决什么问题)、成功标准(可衡量的完成结果)、设计目标(主要必做与次要可选)、用户体验(1-2 段:交互与旅程)、设计理由(1-2 段:为何采用该方案及权衡)、约束/假设(技术约束与业务假设)、功能需求(FR-N 格式,最多 6-8 条,含验收标准)、边界情况(异常输入与失败场景)。验收标准采用 Given/When/Then 格式,每条需求包含 2-4 条标准,覆盖正常路径与关键失败情况。

范围检查:超过 6-8 条需求说明功能过大,应拆分:确定 3-4 条核心需求,其余在“范围说明”章节标记为单独规格。验证清单包括:单一 MVP 焦点、所有需求有可测试标准、无 TODO/TBD 占位符、边界情况已记录。

排除内容:规格定义 WHAT 而非 HOW,因此不包含实现方法或技术策略、架构图、代码示例、数据库模式、API 签名、技术或框架选择、开发估算、时间线或阶段章节。

支持文件:assets/spec.md 为规格模板;references/spec-guide.md 提供关于 ADR 与归档的扩展指导。

限制:资料未提供具体安装命令、收费方式、平台支持或实际效果说明,暂未提供。