Engineering Principles zh CN - FlightDan/dispatcher-sdk GitHub Wiki
接入工程原则
这些原则让持久化 SDK 接入更容易运行和审查。 它们约束的是应用的工程流程;SDK 仍负责执行、存储、租约和投递, 应用负责业务含义和产品验收。完整定义和检查项见详细指南。
| 原则 | 做法 |
|---|---|
| 版本向量(把各层版本放在一起核对) | 分开记录发行版本、实际导入模块、契约、存储 schema(数据结构定义)、registry 和部署身份。 |
| 受监督的生命周期(持续核对运行状态) | 记录所有者、心跳(定期表明仍在运行的信号)、队列进度和停止结果;PID 还在不等于服务健康。 |
| 审查身份 | 分开报告结构可复用性、独立审查、本次 Run(这次运行)验证和发布批准。 |
| 证据闭环(问题何时算解决) | 新来源或日志只是证据,不会自动关闭问题;先定义闭环条件,再独立评估。 |
| 知识与验证 | 只有当前确实需要的知识才会阻塞受影响的工作;实现后的检查仍要在声明的验收关卡执行。 |
| 因果诊断(找出真正导致失败的条件) | 对比精确执行身份、首个致命条件、生命周期里程碑和认证测试覆盖。 |
| 证据阶梯(不同强度的验证) | 明确证据属于 fixture、SDK 集成、重启、模型、构建、运行时,还是产品验收。 |
| 冻结候选(最终审查前固定待验证版本) | 最终审查和全量验证前冻结代码、依赖、registry 和规则。 |
| 安全发现(修改前先找准已有对象) | 变更持久化对象前先定位并匹配;存在歧义时不能创建新的 lineage(对象来源关系)。 |
开始工作前
写下要回答的问题、验收条件、候选身份,以及能回答这个问题的证据等级。 为正在进行的持久化工作保留匹配的部署。复用数据库前阅读存储与升级, 重试中断的 Effect(外部操作记录)前阅读恢复指南。
报告成功前
保留首次失败及解释它的原始证据,明确列出跳过的测试和未验证的能力。 候选、依赖、生成产物或验收规则只要有一项变化,就重新执行最终检查。 绿色测试数量、稳定摘要或 Agent 自报,只能证明实际完成的验证等级。
编程 Agent 请使用验证检查清单。