Files
go-sip/docs/README.md
T

26 lines
3.6 KiB
Markdown
Raw Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
# 文档导航
`docs/` 是本项目设计、合同、决策和验收事实的维护目录。以下入口以**当前项目内隔离 Mock 合同**为准;真实 SaaS/management、供应商、线路、ECS 和生产切换仍未签收。
## 首读顺序
1. [`plan-saas-dispatcher.md`](plan-saas-dispatcher.md):P01–P08 当前实施进度、A01–A12/K01–K16 验收与未验证边界。
2. [`thirds/saas-dispatcher.md`](thirds/saas-dispatcher.md):唯一现行 SaaS↔Dispatcher 项目内通信说明,五类只读 HTTP、固定 `v1` MQ、归属、控制、唯一结果与上传恢复。
3. [`../contracts/local/manifest.json`](../contracts/local/manifest.json) 与 [`../contracts/local/`](../contracts/local/):唯一当前机器 Schema、拓扑、正反例和不可变来源/hash;内部 Agent RPC 见 [`../proto/agent/agent.proto`](../proto/agent/agent.proto)。Markdown 不代替机器校验。
4. [`evidence/saas-dispatcher-implementation.md`](evidence/saas-dispatcher-implementation.md):本地测试、故障/重启与未验证项的可核查证据;[`evidence/saas-dispatcher-p07-audit.md`](evidence/saas-dispatcher-p07-audit.md) 逐项核查旧入口、历史例外与来源/hash。
5. [`../AGENTS.md`](../AGENTS.md):本独立项目开发、SIP、部署、真实呼叫与诊断约束。
## 其它文档
- [`architecture/`](architecture/) 保存产品方案、边界与阶段背景;[`decisions/`](decisions/) 保存设计决定;[`contracts/`](contracts/) 是原有合同和提案记录,当前机器约束以 `../contracts/local/` 为准;[`acceptance/`](acceptance/) 保存跨阶段验收基线,须按本轮单节点/单 Cell/单租户范围核对。
- [`plan-saas-dispatcher-v05-v0.1.md`](plan-saas-dispatcher-v05-v0.1.md) 是**不可变历史来源**:原文件路径和 SHA-256 被当前合同 `manifest.json` 引用,必须保持原字节,不是第二个当前运行计划。旧 [`plan-config-read-v0.1.md`](plan-config-read-v0.1.md)、[`plan-dispatcher-state-v0.1.md`](plan-dispatcher-state-v0.1.md)、[`plan-0926.md`](plan-0926.md)、`thirds/v0.1–v0.4` 和上游 MQ-only v1 只供追溯旧事实,不能覆盖当前项目内合同,也不能作为兼容回退。
- [`archive/`](archive/) 保存旧 W/F 工作包、旧部署样例、上一版 AGENTS 原文,以及 [`contracts-local-history/`](archive/contracts-local-history/README.md) 中 17 个逐字节保留的旧本地 Schema/示例;它们均不参与当前合同或运行校验。[`archive/plan-0918.md`](archive/plan-0918.md) 是旧 W00–W16 原文,不是现在的执行入口。归档说明不能代签真实验收。
- [`evidence/README.md`](evidence/README.md) 说明历史证据保留规则;旧本地结果仍按当时环境和版本解读,不能据此推断当前合同或真实供应商已通过。
- [`../deploys/README.md`](../deploys/README.md) 为 Mock-only 本地发布及物理环境要求,实际新主机/版本/Cell 诊断与拨号前受限抓包见 [`../deploys/test/nonprod-call-evidence.sh`](../deploys/test/nonprod-call-evidence.sh)。本地包检查不替代真实 Asterisk 加载或生产审批。
## 维护规则
- 不在文档中维护第二套 Schema,不改写已被来源/hash 固定的原文;新增当前字段先更新机器合同及正反例,再更新当前说明与来源记录。
- 当前状态只在 `plan-saas-dispatcher.md` 与实施证据中维护;历史文件保留真实来源和阶段,不为消除旧名称而重写归档或受保护的使用者修改。
- 报告须区分本地隔离 Mock、真实非生产和生产,注明哪些测试未执行。源码、样例、日志、证据均不得保存真实凭据、完整用户音频或完整用户对话。