44 lines
3.0 KiB
Markdown
44 lines
3.0 KiB
Markdown
# 运行证据
|
||
|
||
`docs/evidence/` 只保存可复核的运行事实，不保存新的设计结论，也不是每次单元测试的输出目录。
|
||
|
||
## 文档职责
|
||
|
||
- 方案、契约、决策和 [`plan-config-read-v0.1.md`](../plan-config-read-v0.1.md)：记录本轮应遵循的方向、范围与结论；旧 `plan-0918.md` 已归档。
|
||
- 本目录：记录某个 commit、制品、环境和命令实际得到的结果、失败边界和阻塞原因。
|
||
- `docs/archive/evidence/`：保存已被当前基线替代、但仍有追溯价值的历史证据。
|
||
|
||
证据不能单独把“方向已确认”升级为“实现完成”，也不能把本地、Mock 或隔离结果升级为真实供应商、生产或容量验收。本轮状态以[新计划 §8](../plan-config-read-v0.1.md)及适用契约为准；旧 MQ-only 通过范围见[归档原计划](../archive/plan-0918.md)。
|
||
|
||
## 当前入口
|
||
|
||
- [`../plan-config-read-v0.1.md`](../plan-config-read-v0.1.md)：本轮 F00–F06 状态、范围和下一步的唯一开发台账；旧[归档计划](../archive/plan-0918.md)只作历史。
|
||
- [`20260922-mq-only-local-final.md`](20260922-mq-only-local-final.md)：当前 MQ-only 单节点/单 Cell/单租户本地汇总。
|
||
- [`20260920-scope-amendment.md`](20260920-scope-amendment.md)：本轮范围修订事实。
|
||
- [`20260921-mq-v1-contracts.md`](20260921-mq-v1-contracts.md)：MQ-only v1 本地契约验证事实。
|
||
- [`mq-ai-local-roundtrip.md`](mq-ai-local-roundtrip.md)、[`mq-control-recovery.md`](mq-control-recovery.md)：本地 MQ、AI 和恢复边界的专项事实。
|
||
|
||
## 应保留
|
||
|
||
- 当前验收边界的最新汇总；
|
||
- 外部运行环境、供应商响应、部署状态和故障注入结果；
|
||
- 会影响后续设计或回归判断的失败、阻塞和限制；
|
||
- 代码、制品、契约、依赖的版本或哈希，以及可复现命令。
|
||
|
||
## 不应写入
|
||
|
||
- 密钥、密码、私钥、完整 TOKEN、签名 URL；
|
||
- 完整录音、完整用户对话、完整识别文本或原始用户数据；
|
||
- 原始 PCAP、完整运行日志和仅用于一次排错的临时文件；
|
||
- 与已有结果没有新增事实的逐次单测输出或重复重试快照。
|
||
|
||
原始诊断材料如确有必要，只能写入受限的非生产证据目录并按保留期清理；提交到 Git 的内容应是脱敏摘要、计数、状态码、限制和哈希。
|
||
|
||
## 新增与归档规则
|
||
|
||
1. 先更新开发文档中的当前结论，再决定是否需要新增证据。
|
||
2. 只有实现验证、外部环境事实、失败/阻塞或可回归边界才新增证据；普通单元测试由测试和 CI 记录即可。
|
||
3. 同一流程只保留最新汇总和仍有独立决策价值的失败记录；中间版本移到 `docs/archive/evidence/`，不改写历史事实。
|
||
4. 移动证据后必须更新引用；归档证据只能用于还原当时的环境和结果，不能作为当前实现或验收依据。
|
||
5. 新证据至少注明：时间、环境（`mock`/`mixed`/`real`）、代码或制品标识、命令、预期、实际结果、退出码、限制和是否允许据此验收。
|