go-sip/docs

文档导航

docs/ 是本项目唯一的设计、契约、决策和验证文档目录。

首读顺序

1. plan-config-read-v0.1.md：本轮两只读配置接口、有界消费及外呼时段的 F00–F06 执行入口、C/L/M 和 I/M/G 门禁。原 plan-0918.md 已按 HEAD 原文归档，仅作旧 W00–W16 历史。
2. architecture/Go重写方案_v0.3.md：单节点、单 Cell、单租户的总体方案与分期。
3. contracts/：SaaS、Dispatcher、Agent、RabbitMQ 和 OSS 的项目内契约。
4. acceptance/验证与切换验收_v0.3.md：验收门禁、证据要求和第二阶段边界。
5. evidence/20260922-mq-only-local-final.md：当前 MQ-only 本地/隔离范围的最新汇总证据。

按职责查找

方案与范围

• architecture/Go重写方案_v0.3.md：产品范围、运行边界和阶段目标。
• contracts/通信与事件数据交互_v0.1.md：通信、事件、AI 配置和上传边界。
• architecture/G0开发准备与契约冻结提案_v0.1.md：D01–D10 方向及 G0 前置。
• dependencies/开源组件选型与复用清单_v0.2.md：组件、SDK、版本和 PoC 门禁。
• references/OpenAPI与MQ字段索引_v0.1.md：旧源只读索引，不是当前 MQ-only Schema。
• references/saas-page-snapshot-analysis.md：SaaS 页面可见字段盘点；其中旧 MQ 配置建议已被新目标取代，非契约/验收证据。

契约与决策

• thirds/第三方对接事件与请求消费顺序_v0.1.md：只描述 SaaS↔Dispatcher 的配置读取、现行 MQ 呼叫/控制命令及回执、拟定单份最终通话结果；取消对外查询/补传和分散事件尚待签收，替代已删除的六份分散说明。
• ../contracts/upstream/v1/mq.schema.json、event-payloads.schema.json、mq-topology.json：现行 MQ 信封、事件正文、路由的机器契约。
• contracts/config-read-fields-v0.1-proposal.md：两只读接口字段来源、响应结构与项目自拟 Schema/Mock 示例；不是现网 SaaS JSON 或正式合同。
• decisions/：已记录的关键技术决策。

证据

• evidence/README.md：证据与开发文档的职责边界、保留和归档规则。
• evidence/ 保存可复核的运行事实、测试结果和边界说明；历史证据不因当前契约变化而改写。
• 旧 MQ-only 本地结论见归档计划 §8.2和 20260922-mq-only-local-final.md；本轮新方向的状态只在新计划 §8登记。
• 证据中的 mock、mixed、real 必须按原记录理解；本地或隔离通过不等于真实 SaaS、供应商、生产或容量验收通过。

归档

• archive/ 保存已被当前基线替代、但仍需保留追溯价值的文档，包括恢复原文的旧总计划，以及无项目归属的旧参考资料。
• 归档文件不作为当前实现、契约或验收依据；需要引用历史事实时必须使用归档路径。

维护规则

• 不在 docs/ 复制上游 Schema；上游契约包、生成物和字段索引保持单一来源。
• 不把证据摘要改写成新的通过结论；范围、环境和未执行项必须保持可追溯。
• 新增文档先归入方案、契约、决策、证据或归档中的一个明确类别；本轮根目录的 plan-config-read-v0.1.md 是单一执行入口，不新增其它无类别根文件。