概览
公开教程 · 无需登录

小组项目启动

本课启动小组学期项目,四步一次做完:建仓库 → 定规约 → 立规范 → 落骨架。四步的产出各不相同,作用却是一致——让后续课次都能在同一个仓库上、按同一份规约增量交付,而不是每一课重新对齐一遍做法。立规范这一步要产出五类规范的文件:产品设计、后端开发、安全开发、测试、部署运维,课件里每类各有一页明细。仓库是协作与回溯的载体,规约是验收标准,规范是生成的约束,骨架是每课验收的基线。

1本课要交付的四步

四步里只有最后一步产出代码;前三步产出的载体、标准与约束,决定这份代码在反复修改后仍能保持一致。

步骤产出完成后的可验证点在哪一页
建仓库仓库、README、忽略规则、协作约定每人克隆(clone)后按 README 跑通一次;主干随时可启动建仓库与协作约定
定规约一份变更的四份文件与场景清单校验命令通过;另起一次会话只给出仓库路径与变更名,Harness 能照做定边界与规约
立规范规则文件,以及按需调用的技能修改一次代码,生成产物的分层与命名符合规范;另起一次会话结果仍一致工程规范写进规则与技能
落骨架可启动的最小实现、健康检查端点、版本标签克隆 → 填入配置 → 一条命令 → 健康检查端点返回成功,四步无需人工补充说明骨架与核查清单
顺序不是形式要求:前三步各产出一个后面要反复引用的东西——提交历史、场景清单、同一份约束——第四步才有可验证的基线。

2先记住三条结论

规范要落在 Harness 读得到的地方

常驻约束写成规则文件,每次改代码都会被读到;按场景执行的流程写成技能,需要时调用。写在会话里的规范,会话结束即失效,更换成员或更换机器即回到各自的编码习惯——规范只有落在规则文件与技能里,才谈得上持续生效。

规约先于代码,且要判定得出来

每条能力先写成场景:前置条件、操作、可观测结果,再交给 Harness 实现。规约既是给 Harness 的指令,也是验收时逐条对照的表。先写代码后补规约,判定是否完成缺乏客观依据。

骨架是验收基线,不是业务代码

骨架只做一件事:一条命令可启动、健康检查端点返回成功、配置全部外置。它不含任何业务,却是后续课次的起点——没有这条基线,出了问题是骨架缺陷还是当次新增功能的缺陷,无从判定。

建仓库 主干随时可启动 定规约 每条能力的场景 立规范 规则文件与技能 落骨架 一条命令起得来 本课完成 做完一次 后续课次:在同一个仓库上按同一份规约走一轮 提变更 校验规约 实现一组 归档变更 打标签 四步只做一次;缺任何一步,后续课次都要回头补,且代价一次比一次高
四步是后续各课的基线,之后每课只在其上走一轮增量交付;把它们一次做扎实,后面就只需要关心增量本身。

3五个知识点,分别在哪一页

前两个讲「约束落在哪一处」,后三个讲「如何验证它真的生效」。

知识点在哪一页要点
顺序与产出项目启动:四步四步各留下什么、完成现象,以及三类常见的顺序偏差
仓库与协作约定建仓库与协作约定首次提交的三份文件、忽略规则先于代码入库、主干与变更分支约定、密钥边界
边界与规约定边界与规约价值三问与能力清单、规约四份文件、场景三段式与规约验收
规范的两个落点工程规范写进规则与技能规则与技能的分工、五类规范总表、规范生效的判定办法
骨架与核查骨架与核查清单骨架五件事与分层结构、四步完成现象、五维核查清单

4五类规范,分别在哪一页

总表在「工程规范写进规则与技能」一页,五类各有一页明细:条目、检查方式与本课的最小集合。

规范管什么本课必写的最小条目在哪一页
产品设计规范用户与场景、页面清单、视图四状态、文案与术语、视觉基线用户与场景、页面清单、四状态文案模板、术语表产品设计规范
后端开发规范分层与依赖方向、接口命名与版本、响应结构与错误码、幂等、配置外置分层与依赖方向、命名与版本、统一响应、错误码清单、配置外置后端开发规范
安全开发规范默认拒绝与逐资源授权判定、密钥外置与轮换、输入校验与输出转义默认拒绝、逐资源授权判定、密钥外置与轮换、校验白名单、参数绑定安全开发规范
测试规范用例来源与三类组织、数据隔离、一键运行与通过判定一键运行命令、一条能力的三类用例、数据隔离约定测试规范
部署运维规范可复现构建与环境分级、健康检查与日志字段、发布回滚与备份恢复容器化编排文件入库、/health 免认证、单行 JSON 日志带请求标识、版本标签部署运维规范
五类是下限而非上限:可以加第六类(例如数据规范),但加之前先确认现有某一类写不下——分类本身不产生价值,被 Harness 读到并被执行才产生价值。写完可对照「规范案例:CampusClaw」检查:样例里最长的一条不超过五行,但每条都指向一个能当场执行的动作。

5还缺的三类补充规范

五类之外,另有三类:它们不是必修,但缺了会在后续环节暴露。

规范为什么需要在哪一页
AI 应用规范模型输出不可信、提示词会漂移、成本与依赖会失控;缺了它,问题表现为「同样的输入,这周与下周的回答不一样」AI 应用规范
数据规范数据上线后难改:命名与迁移纪律、敏感分级、留存与删除(含向量库与对象存储的副本)数据规范
评审与完成定义规范小组作业最容易失分的地方不是功能没做,而是没人能说清做完了没有评审与完成定义规范
另有两条已并入现有页面,不再单开:性能与容量、限流与配额并入部署运维规范;依赖引入审批与许可证白名单并入安全开发规范。
项目启动:四步四步各产出什么、完成现象,以及三类常见的顺序偏差 建仓库与协作约定首次提交的三份文件、忽略规则先于代码入库、主干与变更分支约定、密钥边界 定边界与规约价值三问与能力清单、规约四份文件、场景三段式与规约验收 工程规范写进规则与技能规则与技能两种落地方式、五类规范、规范生效的判定办法 骨架与核查清单骨架五件事与分层、四步完成现象、五维核查清单 产品设计规范用户与场景、页面清单、视图四状态、文案与术语、视觉基线 后端开发规范分层与依赖方向、接口命名与版本、响应结构与错误码、幂等与并发 安全开发规范默认拒绝与逐资源授权判定、密钥外置与轮换、输入校验与输出转义 测试规范用例来源与三类组织、数据隔离、一键运行与通过判定 部署运维规范可复现构建与环境分级、健康检查与日志字段、发布回滚与备份恢复 AI 应用规范调用边界、提示词即代码、输出校验与不编造依据、评测集与用量观测 数据规范命名与审计字段、迁移纪律、敏感分级、留存与删除的副本清单 评审与完成定义规范完成定义、变更规模上限、评审检查表、例外书面化与证据归档 规约范例:一份变更动因、设计、需求规约、任务清单四份文件原样列出,每份配检查点 规范案例:CampusClaw同一套五类规范的真实写法:术语表、跨班 404、断言判据、发布与回滚顺序 规范样例:八份文件CampusClaw 八份规范文件的完整文本,可逐条对照,也可整份下载 测评样例:单接口一份接口验收表的判定口径与功能、安全测评点,每条写明怎么测、怎样算缺陷 研讨题二十九道讨论题,按四步、五类规范与协作节奏分组,每题给出判据与落点 参考思路每题一句要点与一句追问,讨论之后对照用