速查表:AI 辅助开发工作流清单
下面六组清单可以直接抄进项目约定文件或代码评审(Code Review)模板,作为每次交付前的固定关卡。每组条目顺序即执行顺序,末尾附全套教程索引,可当整套教程的入口。
准备与配置
| 项 | 要点 |
|---|
| 形态选择 | 补全、对话、终端 Agent、多 Agent 各有所长,按任务粒度选,不要一律上最重的形态。 |
| 工具链组合 | 编辑器助手负责行内改写,终端 Agent 负责跨文件任务,本地模型处理敏感代码。 |
| 写规则文件 | 用 AGENTS.md 固定技术栈、目录约定、禁止项与验收命令,纳入版本管理。 |
| 上下文最小化 | 只给相关文件、报错全文与接口定义,避免整仓塞入导致注意力被稀释。 |
| 忽略清单 | 忽略构建产物、依赖目录、密钥与大文件,防止污染上下文与误改。 |
| 密钥与隐私 | 生产凭据、用户数据、内网地址一律不进提示词,必要时代用脱敏样本。 |
| 可回滚起点 | 开工前确认工作区干净或已建分支/工作树,随时能一键放弃。 |
| 权限边界 | 明确 Agent 可写目录与不可写目录,禁止直接操作生产环境与主干。 |
需求与规格
| 项 | 要点 |
|---|
| 规格先行 | 把需求写成可执行的规格:输入、输出、错误情形、验收命令,先规格后代码。 |
| 验收标准 | 每条需求配一条可自动执行的验收命令,写不出命令说明需求还不够具体。 |
| 非目标清单 | 明写本次不做的事,防止实现顺手扩张范围。 |
| 目录与分层 | 先定目录分层与依赖方向,让新增代码有唯一正确的位置。 |
| 接口签名 | 先定接口签名、类型与占位实现,再并行填充,减少返工。 |
| 边界与错误码 | 空值、超长、并发、权限不足、下游超时都要写明预期行为与错误码。 |
| 示例数据 | 给出最小可用的样例输入输出,比形容词更能约束实现。 |
| 任务粒度 | 每个子任务控制在一次可评审的规模,便于小步提交与回滚。 |
编码与测试
| 项 | 要点 |
|---|
| 小步提交 | 一次只做一件事,避免大爆炸式重写,让每步都能单独回滚。 |
| 单关注点 | 同一个改动里不混重构与功能,否则评审无法分辨行为变化。 |
| 失败用例先行 | 先让测试红,再让它绿,避免写出永远通过的测试。 |
| 表驱动测试 | 用例用表格组织,边界值、正常值、异常值各占一行。 |
| 边界用例 | 空集合、单元素、超限、重复调用、并发调用都要覆盖。 |
| 伪实现 | 用桩(stub)与假实现(fake)隔离外部依赖,禁止 mock 掉被测逻辑。 |
| 断言不弱化 | 校验错误码、字段值与副作用,不接受只判非空。 |
| 重构行为不变 | 重构前后跑同一套测试,必要时补特征测试锁住旧行为。 |
| SQL 与迁移 | 审查 DDL 影响面、索引用意、锁表时长,并准备回滚脚本。 |
| 生成产物重跑 | 代码生成、锁文件、迁移汇总一律由命令重新生成。 |
评审与调试
| 项 | 要点 |
|---|
| 先复现 | 拿到报错先稳定复现,再让 AI 分析,避免基于猜测改代码。 |
| 报错全文 | 贴完整堆栈与首条异常,不要只贴最后一行。 |
| 二分排查 | 用注释、开关、版本回退把范围二分,快速锁定引入点。 |
| 假设验证 | 让 AI 列出两三个竞争假设,再逐条设计验证实验。 |
| 幻觉 API 识别 | 逐个核对函数、参数、配置项是否真实存在,编译与静态检查必跑。 |
| 自查清单 | 按变更类型清点:接口兼容、错误处理、日志、并发、资源释放。 |
| 多 Agent 文件隔离 | 并行单位是文件,开工前分配独占文件集合,共享文件先冻结。 |
| 共享文件串行化 | 接口、类型、常量、路由、迁移序号由地基步骤一人先改完。 |
| 独立验证者 | 写代码的 Agent 不兼任验证者,验证方只读并独立复现。 |
| 冲突后全量验证 | 合并后重跑编译、全量测试与契约测试,并重新生成产物。 |
文档与提交
| 项 | 要点 |
|---|
| README 结构 | 定位、快速开始、配置项、常用命令、目录结构、部署、排错,逐段核对事实来源。 |
| 注释写为什么 | 写约束、不变量、反直觉取舍与失效条件,不复述代码字面含义。 |
| 提交信息规范 | 遵循 Conventional Commits:类型、范围、一句话摘要、为什么、影响面。 |
| 从 diff 生成说明 | 输入真实 diff 与需求编号,要求按模板输出并标注不确定项。 |
| 不编造改动 | 明令禁止「顺便」「同时优化」这类 diff 中不存在的表述,逐条回查。 |
| 破坏性变更 | 接口、配置、数据格式变更必须显式标注并给出迁移提示。 |
| 变更日志 | 由单人统一整理,按版本归类,不与提交历史重复粘贴。 |
| 提交原子性 | 一个提交一个可回滚的完整改动,文档更新与代码改动同批提交。 |
度量
| 项 | 要点 |
|---|
| 硬门槛 | 编译、测试、静态检查、格式、覆盖率、迁移可回滚全部通过才算交付。 |
| 一票否决项 | 跳过测试、弱化断言、吞异常、硬编码凭据、格式化噪音,发现即驳回。 |
| 首次通过率 | 变更第一次提交就通过评审与流水线的比例,反映规格与提示词质量。 |
| 返工次数 | 同一任务被要求重做的轮次,平均超过一次说明规格不透彻。 |
| 变更规模 | 单次 diff 行数保持小而完整,规模失控先怀疑任务拆分。 |
| 审查发现问题数 | 每百行变更发现的真实缺陷,数值为零通常意味着评审走过场。 |
| 缺陷逃逸 | 合并后由下游或生产发现的问题,按归因回写规则文件。 |
| 指标成对看 | 速度指标必须配质量指标,单一指标一定被刷。 |
| 回归用例固化 | 每个真实缺陷补一条用例,让同类问题不再复发。 |
| 模板沉淀 | 有效提示词与验收清单入库、评审、留修订记录,失效的及时删除。 |
全套教程索引
| NN | 主题 | 一句话 |
|---|
| 01 | 从补全到 Agent | 认清四种形态的能力边界,先选对工具再谈效率。 |
| 02 | 工具链搭建 | 编辑器助手、终端 Agent 与本地模型如何组合。 |
| 03 | 给 AI 立规矩 | AGENTS.md 与项目约定文件的写法。 |
| 04 | 上下文管理 | 让它看见该看的,而不是全部。 |
| 05 | 规格先行 | 把需求写成可执行的规格与验收标准。 |
| 06 | 让 AI 搭骨架 | 目录分层、接口签名与占位实现。 |
| 07 | 代码生成与改写 | 小步提交,避免大爆炸式重写。 |
| 08 | 用 AI 写测试 | 表驱动、边界用例与伪实现。 |
| 09 | 用 AI 调试 | 报错定位、二分排查与假设验证。 |
| 10 | AI 代码评审 | 自查清单与幻觉 API 识别。 |
| 11 | 用 AI 重构 | 遗留代码梳理与行为不变替换。 |
| 12 | 用 AI 写 SQL 与迁移 | DDL 审查、索引用意与回滚预案。 |
| 13 | 文档与提交信息 | README、注释与提交信息的事实核对。 |
| 14 | 多 Agent 协作 | 文件级隔离、共享文件串行化与冲突合并。 |
| 15 | 度量与验收 | 量化口径、一票否决项与防退化机制。 |
| 16 | 速查表 | 本章:六组交付前清单与全套索引。 |
小结:这六组清单的价值在于固定顺序——先准备与规格,再编码与测试,然后评审与调试,最后文档、提交与度量;把清单抄进规则文件并按验收命令执行,AI 辅助开发才能从「偶尔好用」变成稳定的流程。