知识点思维导图
17 个知识节点
工程化工作流(09) - GitHub Spec Kit
读完后,你应能完成以下任务:
- 绘制“工程化工作流(09) - GitHub Spec Kit / 最小使用流程”的关键对象与数据流,解释“而是上游产物成为下游输入:任务必须能追踪到需求场景,”,并用源码位置、日志或 Trace 标注证据。
- 为“工程化工作流(09) - GitHub Spec Kit / 写规格时保持 What 与 How 分离”设计正常与异常输入,验证“plan 再根据仓库真实技术栈决定软删除字段、过期任务、恢复接口和并发控制。”,输出首个偏差位置与回归测试结果。
- 实现“工程化工作流(09) - GitHub Spec Kit / 与 OpenSpec 的选择”的最小代码或配置,检验“适合新项目、复杂功能和严格追踪;”,输出命令、结果与 Diff,并说明不适用边界。
Spec Kit 把规格放在开发主流程中:项目原则约束需求,需求推导计划,计划拆出任务,最后用追踪关系检查实现是否完整。
核心知识清单
- constitution 的长期质量与架构原则
- specify 的 What、Why 与独立验收场景
- clarify 的高影响歧义消除
- plan 的技术上下文、数据模型与接口契约
- tasks 的依赖、并行标记和文件落点
- analyze 的一致性、覆盖率与追踪检查
- implement 的执行顺序和完成证据
一、先建立全局:GitHub Spec Kit 是什么?
理解“GitHub Spec Kit”,先要把标题中的对象放进同一条处理链:它接收什么输入,经过哪些状态变化,最终用什么证据判断结果。下表不另造概念,只把作者正文已经解释的章节按依赖顺序连起来。
“GitHub Spec Kit”的第一个核心判断是:而是上游产物成为下游输入:任务必须能追踪到需求场景,。先弄清这个判断中的对象和输入输出,后面的实现、故障和验收才有共同语境。
| 顺序 | 章节 | 读完本节应抓住的结论 |
|---|---|---|
| 1 | 最小使用流程 | 而是上游产物成为下游输入:任务必须能追踪到需求场景, |
| 2 | 写规格时保持 What 与 How 分离 | plan 再根据仓库真实技术栈决定软删除字段、过期任务、恢复接口和并发控制。 |
| 3 | 与 OpenSpec 的选择 | 适合新项目、复杂功能和严格追踪; |
| 4 | constitution 的长期质量与架构原则 | | constitution | 不随单个功能变化的原则 | 为赶进度绕过测试、安全或架构边界 | |
| 5 | clarify 的高影响歧义消除 | | clarify | 已解决的高影响歧义 | Agent 对权限、失败、数据生命周期自行猜测 | |
| 6 | plan 的技术上下文、数据模型与接口契约 | plan 再根据仓库真实技术栈决定软删除字段、过期任务、恢复接口和并发控制。 |
1.1 核心对象之间怎样衔接
flowchart LR
S1["最小使用流程"] --> S2
S2["写规格时保持 What 与 How 分离"] --> S3
S3["与 OpenSpec 的选择"] --> S4
S4["constitution 的长期质量与架构原则"] --> S5
S5["clarify 的高影响歧义消除"]
这张图只表达本文的讲解顺序,不替代正文机制。判断“GitHub Spec Kit”是否真正掌握,需要能从最后一个结果沿图回到前面每个章节的输入、状态变化和证据。
1.2 再看失败:问题最早会出现在哪一步?
在“GitHub Spec Kit”的对象和顺序已经明确后,再看可观察的失败:文本直通执行、状态不可重放或重试重复写入。定位时不从最后一条错误猜原因,而是沿上图找第一个偏离正文结论的节点。
二、七个阶段不是七份形式文档
| 阶段 | 关键产物 | 应阻止的问题 |
|---|---|---|
| constitution | 不随单个功能变化的原则 | 为赶进度绕过测试、安全或架构边界 |
| specify | 用户目标、场景、非目标 | 过早绑定技术方案,遗漏可独立验收的需求 |
| clarify | 已解决的高影响歧义 | Agent 对权限、失败、数据生命周期自行猜测 |
| plan | 技术方案、数据模型、契约、研究结论 | 设计与仓库事实、项目原则冲突 |
| tasks | 有依赖的可执行清单 | 任务不可验证、遗漏测试或修改位置不明确 |
| analyze | 规格、计划、任务一致性报告 | 需求没有任务、任务没有来源、术语互相冲突 |
| implement | 代码、测试和验证记录 | 跳过依赖顺序,空口声明完成 |
三、最小使用流程
# 安装官方 CLI;团队应固定 release,而不是长期追随 main。
uv tool install specify-cli
# 在现有目录初始化时选择真实使用的 Agent 集成。
specify init . --integration codex
/speckit.constitution 建立测试、安全、可观测性和最小改动原则
/speckit.specify 用户可以在 15 分钟内撤销误删项目
/speckit.clarify
/speckit.plan 使用现有 PostgreSQL 与任务队列,不增加新中间件
/speckit.tasks
/speckit.analyze
/speckit.implement
Codex 或其他 Skill 宿主可能使用 $speckit-* 名称,
具体调用形式以初始化结果为准。
关键不是命令拼写,
而是上游产物成为下游输入:任务必须能追踪到需求场景,
代码和测试必须能追踪到任务。
四、写规格时保持 What 与 How 分离
specify 写“用户能撤销、超时后不可撤销、无权限时拒绝”,不先写表名和队列。
plan 再根据仓库真实技术栈决定软删除字段、过期任务、恢复接口和并发控制。
这样技术方案调整时,用户承诺仍然稳定;
业务目标变化时,系统也能识别哪些技术任务已经失效。
clarify 只处理会改变范围、数据模型、安全或验收的高影响问题。
小的实现细节留给计划阶段,否则澄清会退化成穷举所有可能。
analyze 应在实现前运行,也应在重大规格变化后重跑。
五、与 OpenSpec 的选择
Spec Kit 更强调从 constitution 到 implement 的完整阶段链, 适合新项目、复杂功能和严格追踪; OpenSpec 以 current specs + change delta 管理存量项目更轻。 团队可以只选一个作为规格事实来源; 同时运行两套时必须规定谁是主记录、如何同步,否则会制造双份真相。
学完验收
- 能为一个功能写出三个可独立验收场景和明确非目标。
tasks中每项都有输入、修改位置、输出和验证方式。analyze能发现至少一种需求遗漏、原则冲突或任务无来源问题。
六、动手验证:先跑通 GitHub Spec Kit,再改变一个变量
前面的章节已经建立问题、概念和机制。现在把“GitHub Spec Kit”放进同一套基线中运行;本节不再引入新术语,只验证前文结论能否被复现。
6.1 基线与候选只允许一个变量不同
验证“GitHub Spec Kit”时,先固定工具 Schema、身份、畸形参数、超时和重复请求。候选方案只能改变本次要验证的变量;如果同时更换数据、依赖和配置,即使结果改善,也不能知道是哪一项产生作用。
执行“GitHub Spec Kit”时,动作是:回放决策到执行链路,覆盖失败、重试、暂停和恢复。原始结果不能只保留截图或汇总分数,必须同步保存:模型提议、校验、授权、幂等键、状态迁移、Trace,使下一次复查可以在同一输入上重放。
| 实验要素 | 本文要求 |
|---|---|
| 固定条件 | 工具 Schema、身份、畸形参数、超时和重复请求 |
| 唯一变量 | 本次候选方案与基线之间的一项明确差异 |
| 原始证据 | 模型提议、校验、授权、幂等键、状态迁移、Trace |
| 通过阈值 | 模型只提议;执行受代码约束;失败不重复副作用 |
| 立即停止 | 文本直通执行、状态不可重放或重试重复写入 |
6.2 执行前先排除不可比较条件
“GitHub Spec Kit”开始前先确认下面四项;任一项不成立,都应先修复实验条件,而不是解释结果。
- 基线能够在“GitHub Spec Kit”的当前环境重复运行。
- 候选只改变一个与“GitHub Spec Kit”结论直接相关的条件。
- “GitHub Spec Kit”的基线和候选使用同一批输入、同一版本依赖与同一通过阈值。
- “GitHub Spec Kit”的原始输出和失败现场不会被重试、格式化或汇总覆盖。
6.3 执行后先核对证据完整性
结果出来后先检查证据,再讨论“GitHub Spec Kit”是否通过。缺少中间状态时,最终输出只能说明现象,不能证明机制。
| 检查项 | 当前文章的判定 |
|---|---|
| 输入可追溯 | 工具 Schema、身份、畸形参数、超时和重复请求 |
| 过程可回放 | 回放决策到执行链路,覆盖失败、重试、暂停和恢复 |
| 结果可审计 | 模型提议、校验、授权、幂等键、状态迁移、Trace |
“GitHub Spec Kit”的一次合格基线对照按以下顺序执行:
- 保存“GitHub Spec Kit”基线版本及输入摘要,确认基线本身可以重复运行。
- 写下“GitHub Spec Kit”候选方案唯一变化的变量,以及它预期影响的指标。
- 在同一环境执行“GitHub Spec Kit”:回放决策到执行链路,覆盖失败、重试、暂停和恢复。
- 为“GitHub Spec Kit”保存:模型提议、校验、授权、幂等键、状态迁移、Trace。
- 使用“GitHub Spec Kit”预登记条件判断:模型只提议;执行受代码约束;失败不重复副作用。
- 如果“GitHub Spec Kit”未通过,不修改第二个变量,先恢复基线并保留失败现场。
七、用一张矩阵验证 GitHub Spec Kit 的关键结论
矩阵按正文顺序列出“GitHub Spec Kit”的结论。一次实验只选择一行,只改变这一行对应的条件;不要把多行合并成一个无法归因的大实验。
| 正文章节 | 已解释的结论 | 本轮唯一变量 | 必须保存的证据 |
|---|---|---|---|
| 最小使用流程 | 而是上游产物成为下游输入:任务必须能追踪到需求场景, | 只改变与“最小使用流程”相关的条件 | 模型提议、校验、授权、幂等键、状态迁移、Trace |
| 写规格时保持 What 与 How 分离 | plan 再根据仓库真实技术栈决定软删除字段、过期任务、恢复接口和并发控制。 | 只改变与“写规格时保持 What 与 How 分离”相关的条件 | 模型提议、校验、授权、幂等键、状态迁移、Trace |
| 与 OpenSpec 的选择 | 适合新项目、复杂功能和严格追踪; | 只改变与“与 OpenSpec 的选择”相关的条件 | 模型提议、校验、授权、幂等键、状态迁移、Trace |
| constitution 的长期质量与架构原则 | | constitution | 不随单个功能变化的原则 | 为赶进度绕过测试、安全或架构边界 | | 只改变与“constitution 的长期质量与架构原则”相关的条件 | 模型提议、校验、授权、幂等键、状态迁移、Trace |
| clarify 的高影响歧义消除 | | clarify | 已解决的高影响歧义 | Agent 对权限、失败、数据生命周期自行猜测 | | 只改变与“clarify 的高影响歧义消除”相关的条件 | 模型提议、校验、授权、幂等键、状态迁移、Trace |
| plan 的技术上下文、数据模型与接口契约 | plan 再根据仓库真实技术栈决定软删除字段、过期任务、恢复接口和并发控制。 | 只改变与“plan 的技术上下文、数据模型与接口契约”相关的条件 | 模型提议、校验、授权、幂等键、状态迁移、Trace |
7.1 记录本次实际实验
下面的记录用于“GitHub Spec Kit”当前这一次实验,不是第二套知识目录。先从矩阵选择一个章节,再填写实际值;没有填写的字段表示尚未验证。
topic: "GitHub Spec Kit"
selected_chapter: required
claim_from_article: required
baseline_version: required
changed_condition: exactly_one
execution: "回放决策到执行链路,覆盖失败、重试、暂停和恢复"
evidence: "模型提议、校验、授权、幂等键、状态迁移、Trace"
pass_when: "模型只提议;执行受代码约束;失败不重复副作用"
stop_when: "文本直通执行、状态不可重放或重试重复写入"
observed_result: required
first_deviation: null_or_evidence
recovery_replay: required_after_failure
7.2 边界实验必须证明能够停止和恢复
成功路径只能证明“GitHub Spec Kit”在当前样本上工作,不能证明它可以进入生产。边界实验需要主动制造:文本直通执行、状态不可重放或重试重复写入,并观察系统是否在产生不可逆副作用前停止。
| 场景 | 只改变什么 | 应保存什么 | 通过标准 |
|---|---|---|---|
| 正常路径 | 使用已知有效输入 | 模型提议、校验、授权、幂等键、状态迁移、Trace | 模型只提议;执行受代码约束;失败不重复副作用 |
| 边界路径 | 把一个输入推进到约束临界值 | 临界值前后的输出与指标 | 不静默降级,不把部分结果冒充成功 |
| 明确失败 | 注入:文本直通执行、状态不可重放或重试重复写入 | 原始错误、首个异常阶段和最终状态 | 失败被正确分类且没有扩大副作用 |
| 恢复重放 | 执行:关闭副作用入口,恢复检查点,补充失败契约测试 | 原失败样本的复测证据 | 原样本恢复,正常样本没有回归 |
恢复动作不是简单重启。对于“GitHub Spec Kit”,第一步是:关闭副作用入口,恢复检查点,补充失败契约测试。完成后使用原始失败样本复测;只验证一个新样本成功,不能证明触发条件已经消失。
“GitHub Spec Kit”边界实验结束后,应把正常、临界、失败和恢复四类记录放在同一个运行批次中。这样才能区分“候选方案真的修复问题”和“环境变化让问题暂时没有出现”。
八、GitHub Spec Kit 的结果解释
解释“GitHub Spec Kit”实验时先看首个偏差,而不是最后一条错误。最后的异常通常只是上游状态错误的结果;从末端反推容易误把症状当根因。
| 观察结果 | 可以支持的判断 | 下一步 |
|---|---|---|
| 主链路没有达到预期 | 文本直通执行、状态不可重放或重试重复写入 | 先执行:关闭副作用入口,恢复检查点,补充失败契约测试 |
| 异常链路无法恢复 | 文本直通执行、状态不可重放或重试重复写入 | 先执行:关闭副作用入口,恢复检查点,补充失败契约测试 |
| 新样本成功但原样本仍失败 | 修复没有覆盖原始触发条件 | 固定原失败输入,恢复基线后重新比较 |
| 指标改善但证据无法回链 | 数据、版本或中间状态没有固定 | 暂停发布,补齐可追溯记录后重跑 |
“GitHub Spec Kit”只有同时满足“模型只提议;执行受代码约束;失败不重复副作用”,并且没有出现“文本直通执行、状态不可重放或重试重复写入”,才可以认为主链路通过。这里的“通过”只对当前固定版本、样本和环境有效,不能外推到尚未测试的容量、权限或数据分布。
如果“GitHub Spec Kit”候选方案与基线差异很小,先检查证据分辨率是否足够;如果差异很大,先排除数据泄漏、环境漂移和版本不一致。两种情况都不能只看一个汇总均值,需要回到逐样本输出和中间状态。
“GitHub Spec Kit”故障定位完成后,记录“现象、首个偏差、根因、改动、原样本复测”五项。缺少原样本复测时,只能标记为待观察,不能标记为已解决。
九、GitHub Spec Kit 的发布判断
发布判断需要把“GitHub Spec Kit”的质量、失败边界和恢复能力放在同一份记录中。以下任一条件缺失,都应停止扩量,而不是用“基本正常”替代证据。
- “GitHub Spec Kit”的基线与候选只存在一个计划内变量。
- “GitHub Spec Kit”的输入、代码、依赖、配置和数据版本可以追溯。
- “GitHub Spec Kit”的正常、临界、失败和恢复样本使用同一套断言。
- “GitHub Spec Kit”的原始输出、中间状态和失败现场已经保留。
- “GitHub Spec Kit”的日志、Trace、截图和测试数据已经脱敏。
- “GitHub Spec Kit”的停止条件、负责人和回滚入口已经演练。
- “GitHub Spec Kit”尚未覆盖的输入、权限、容量和外部依赖已经登记。
最终记录至少包含基线版本、唯一变量、原始证据、首个偏差、恢复复测和发布责任人。没有参与本次修改的人如果不能据此重放“GitHub Spec Kit”的判断,就不能发布。
十、总结
- 七个阶段不是七份形式文档:| constitution | 不随单个功能变化的原则 | 为赶进度绕过测试、安全或架构边界 |
- 最小使用流程:关键不是命令拼写,而是上游产物成为下游输入:任务必须能追踪到需求场景,代码和测试必须能追踪到任务。
- 写规格时保持 What 与 How 分离:plan 再根据仓库真实技术栈决定软删除字段、过期任务、恢复接口和并发控制。
- 与 OpenSpec 的选择:Spec Kit 更强调从 constitution 到 implement 的完整阶段链,适合新项目、复杂功能和严格追踪;
学完自测
选择所有正确答案;提交后逐项核对判断依据。