规范要落在 Harness 读得到的地方
常驻约束写成规则文件,每次改代码都会被读到;按场景执行的流程写成技能,需要时调用。写在会话里的规范,会话结束即失效,更换成员或更换机器即回到各自的编码习惯——规范只有落在规则文件与技能里,才谈得上持续生效。
本课启动小组学期项目,四步一次做完:建仓库 → 定规约 → 立规范 → 落骨架。四步的产出各不相同,作用却是一致——让后续课次都能在同一个仓库上、按同一份规约增量交付,而不是每一课重新对齐一遍做法。立规范这一步要产出五类规范的文件:产品设计、后端开发、安全开发、测试、部署运维,课件里每类各有一页明细。仓库是协作与回溯的载体,规约是验收标准,规范是生成的约束,骨架是每课验收的基线。
四步里只有最后一步产出代码;前三步产出的载体、标准与约束,决定这份代码在反复修改后仍能保持一致。
| 步骤 | 产出 | 完成后的可验证点 | 在哪一页 |
|---|---|---|---|
| 建仓库 | 仓库、README、忽略规则、协作约定 | 每人克隆(clone)后按 README 跑通一次;主干随时可启动 | 建仓库与协作约定 |
| 定规约 | 一份变更的四份文件与场景清单 | 校验命令通过;另起一次会话只给出仓库路径与变更名,Harness 能照做 | 定边界与规约 |
| 立规范 | 规则文件,以及按需调用的技能 | 修改一次代码,生成产物的分层与命名符合规范;另起一次会话结果仍一致 | 工程规范写进规则与技能 |
| 落骨架 | 可启动的最小实现、健康检查端点、版本标签 | 克隆 → 填入配置 → 一条命令 → 健康检查端点返回成功,四步无需人工补充说明 | 骨架与核查清单 |
常驻约束写成规则文件,每次改代码都会被读到;按场景执行的流程写成技能,需要时调用。写在会话里的规范,会话结束即失效,更换成员或更换机器即回到各自的编码习惯——规范只有落在规则文件与技能里,才谈得上持续生效。
每条能力先写成场景:前置条件、操作、可观测结果,再交给 Harness 实现。规约既是给 Harness 的指令,也是验收时逐条对照的表。先写代码后补规约,判定是否完成缺乏客观依据。
骨架只做一件事:一条命令可启动、健康检查端点返回成功、配置全部外置。它不含任何业务,却是后续课次的起点——没有这条基线,出了问题是骨架缺陷还是当次新增功能的缺陷,无从判定。
前两个讲「约束落在哪一处」,后三个讲「如何验证它真的生效」。
| 知识点 | 在哪一页 | 要点 |
|---|---|---|
| 顺序与产出 | 项目启动:四步 | 四步各留下什么、完成现象,以及三类常见的顺序偏差 |
| 仓库与协作约定 | 建仓库与协作约定 | 首次提交的三份文件、忽略规则先于代码入库、主干与变更分支约定、密钥边界 |
| 边界与规约 | 定边界与规约 | 价值三问与能力清单、规约四份文件、场景三段式与规约验收 |
| 规范的两个落点 | 工程规范写进规则与技能 | 规则与技能的分工、五类规范总表、规范生效的判定办法 |
| 骨架与核查 | 骨架与核查清单 | 骨架五件事与分层结构、四步完成现象、五维核查清单 |
总表在「工程规范写进规则与技能」一页,五类各有一页明细:条目、检查方式与本课的最小集合。
| 规范 | 管什么 | 本课必写的最小条目 | 在哪一页 |
|---|---|---|---|
| 产品设计规范 | 用户与场景、页面清单、视图四状态、文案与术语、视觉基线 | 用户与场景、页面清单、四状态文案模板、术语表 | 产品设计规范 |
| 后端开发规范 | 分层与依赖方向、接口命名与版本、响应结构与错误码、幂等、配置外置 | 分层与依赖方向、命名与版本、统一响应、错误码清单、配置外置 | 后端开发规范 |
| 安全开发规范 | 默认拒绝与逐资源授权判定、密钥外置与轮换、输入校验与输出转义 | 默认拒绝、逐资源授权判定、密钥外置与轮换、校验白名单、参数绑定 | 安全开发规范 |
| 测试规范 | 用例来源与三类组织、数据隔离、一键运行与通过判定 | 一键运行命令、一条能力的三类用例、数据隔离约定 | 测试规范 |
| 部署运维规范 | 可复现构建与环境分级、健康检查与日志字段、发布回滚与备份恢复 | 容器化编排文件入库、/health 免认证、单行 JSON 日志带请求标识、版本标签 | 部署运维规范 |
五类之外,另有三类:它们不是必修,但缺了会在后续环节暴露。
| 规范 | 为什么需要 | 在哪一页 |
|---|---|---|
| AI 应用规范 | 模型输出不可信、提示词会漂移、成本与依赖会失控;缺了它,问题表现为「同样的输入,这周与下周的回答不一样」 | AI 应用规范 |
| 数据规范 | 数据上线后难改:命名与迁移纪律、敏感分级、留存与删除(含向量库与对象存储的副本) | 数据规范 |
| 评审与完成定义规范 | 小组作业最容易失分的地方不是功能没做,而是没人能说清做完了没有 | 评审与完成定义规范 |