实用指南

Spec Guides

面向真实交付场景的短指南。先用一页清单收敛问题,再进入模板和长文,不必在项目推进时切换思维模式。

8 篇问题导向,而不是空泛理论
工作流优先围绕草拟、评审、测试和发布设计
模板可接续每篇都能自然衔接到可复用资产

按当前任务选择指南路径

从粗略需求草拟规格

先用 PRD 转规格流程拆解业务目标,再用模板示例把产品语言转成研发、测试和评审都能使用的结构。

进入草拟路径

把验收标准写到可测试

当 QA 需要明确的状态、操作、预期结果和边界情况时,先看验收标准示例,再套用 Given/When/Then 模板。

进入验收路径

实现前完成评审

编码前用规格评审清单和边界情况清单过一遍,尤其适合涉及权限、数据、依赖和上线回滚的改动。

进入评审路径

约束 AI 生成代码

用 AI 编码 Prompt 模板把输出绑定到规格、非目标、验收标准和测试证据,减少模型自行扩展范围。

进入 AI 路径

每篇指南能给你什么

每篇指南遵循相同结构:先说明这个主题为什么重要(一段话),再给出一个可以直接复制进规格或 ticket 的示例,最后是覆盖边界情况、角色专属问题和决策规则的深度内容。设计目标是:在 Sprint 开始时打开,5 分钟内扫完,带着一个可落地的产出离开。

指南比博客文章刻意更短。博客文章深入解释某个实践背后的原理,指南优先给你清单或模板——附带足够的上下文让你能直接使用,而不必先读完理论部分。

如何在团队中使用这些指南

最有效的使用方式是在规格评审会前按角色分配:PM 读 PRD 转规格指南和范围清单,技术负责人读边界情况和 API 契约清单,QA 读验收标准示例和规格评审清单。每个人带着自己职责范围内的专属问题参会,而不是所有人审查同一个层面。

如果评审前不足 30 分钟,从规格评审清单开始——它是发现返工根源最快的方式:缺少回滚步骤、无法测试的验收标准、未确认的依赖项。

什么时候用指南,什么时候用模板

当你在回答问题时用指南:"好的验收标准长什么样?"或"我最容易漏掉哪些边界情况?"当你准备好动手写时用模板:你知道要记录什么,只需要一个结构化的格式来填写。

大多数规格工作从指南开始——校准什么叫"写好了"——然后切换到模板来生成实际的产出物。本页指南都链接了对应的模板,可以在两者之间无缝切换。

从哪篇开始

如果团队跳过规格评审或因需求理解错误频繁返工:从规格评审清单开始。它在最短的时间内暴露最常见的缺口。

如果团队写了规格但 QA 测试阶段仍频繁发现问题:从验收标准示例开始——最常见的问题是写出了技术上正确但无法在不追问的情况下测试的标准。

如果使用 AI 编码工具但输出频繁偏离需求:从 AI Coding Prompt 模板开始。

按失败信号快速选择

联调时才发现接口理解不一致

先读 API 契约检查清单,再回到 API 模板补字段语义、错误结构、幂等规则和版本策略。重点不是补文档,而是让消费者和生产者共享同一份可测试契约。

检查 API 契约

QA 总要追问“怎么算完成”

从验收标准示例和 Given/When/Then 模板开始,把模糊需求改写成前置状态、触发动作和可观测结果。这样测试计划可以在实现前形成,而不是等代码写完再补。

改写验收标准

AI 生成代码经常超出范围

先完成规格评审,再用 AI Prompt 模板把目标、非目标、限制条件和测试证据一起输入。模型需要边界,团队也需要能判断输出是否偏离规格的材料。

约束 AI 输出

一次评审里如何组合使用指南

先看最高风险问题

如果改动影响用户可见行为,先看验收标准;如果影响服务边界,先看 API 契约;如果风险在数据、权限或上线,先看边界情况和评审清单。

让每个角色负责一个角度

产品负责挑战范围和非目标,研发负责挑战契约和发布路径,QA 负责挑战结果是否可观测。不同角色带着不同责任读指南,比所有人泛泛浏览更有效。

最后落到一个产物

一次评审应该产出更新后的规格、清单或 Prompt。如果团队读了几篇指南,但没有任何产物发生变化,这次评审大概率只是增加了认知,没有形成可执行决策。

面向开发团队的规格模板示例

可直接复用的 feature、API 与数据库规格模板示例,帮助团队写出更可测试的文档。

阅读指南

上线前的 API 契约检查清单

发布 API 之前,先用这份清单检查 schema、错误码、版本兼容、幂等和监控字段。

阅读指南

如何把 PRD 转成可测试规格

把 PRD 中的业务目标拆成可执行规格:目标、非目标、验收标准、边界条件和上线策略。

阅读指南

可复用的验收标准示例

一组可直接借用的验收标准示例,覆盖主流程、失败路径、权限和重试场景。

阅读指南

规格里的 Given/When/Then 模板

一个适合规格和测试设计的 Given/When/Then 模板,覆盖成功、失败和权限条件。

阅读指南

编码前的边界情况检查清单

编码前先用这份清单扫一遍空值、重复、限制、竞态、权限和回滚问题。

阅读指南

实现前的规格评审清单

给 PM、开发、QA 和运维共用的规格评审清单,覆盖范围、验收、依赖和发布安全。

阅读指南

让 AI 编码遵守规格的 Prompt 模板

一套让 AI coding 更守边界的 prompt 模板,强调范围、契约、测试证据和禁止事项。

阅读指南