1.5 KiB
1.5 KiB
name, description
| name | description |
|---|---|
| change-annotation-audit | 对每次修改强制生成审计记录(docs/ai_audit/changes/...),并在每个被改文件写 AI_CHANGELOG、在逻辑变更处写 CHANGE 标记注释(包含日期、Prompt 与直接原因)。 |
目的
把“为什么改、怎么改、怎么验”固化到可审计产物中,满足资金相关项目的严谨性要求。
触发条件
- 任何对代码或文档的实质修改(非纯格式化)
- 特别是:逻辑改动、资金口径改动、接口契约改动、DB 结构改动
必须产物(缺一不可)
docs/ai_audit/changes/<YYYY-MM-DD>__<slug>.md- 每个被修改文件内的
AI_CHANGELOG条目 - 每个逻辑变更附近的
CHANGE标记注释
工作流
1) Prompt 溯源
- 确认本次修改有 Prompt-ID(来自 prompt_log.md)
- 若没有,先补写 Prompt-ID,再继续
2) 写审计记录(Per-change)
使用模板:assets/audit-record-template.md
- 必须写:原始原因(Prompt)、直接原因、改动方案简介、文件清单、风险/回滚/验证
3) 写文件内 AI_CHANGELOG(Per-file)
- 对每个修改的文件追加一条 AI_CHANGELOG
- 选择适合语言/文件类型的注释风格(模板见 assets/file-changelog-templates.md)
4) 写 CHANGE 标记(Block-level)
- 对每处逻辑变更,必须在附近写 CHANGE 标记
- 必须包含:intent、assumptions、边界条件(金额/舍入/精度)、验证提示
模板
assets/audit-record-template.mdassets/file-changelog-templates.md