docs: 整理文档目录结构 — 清理过时文档、归集功能子目录、统一命名规范
清理: - 删除 34 份过时文档(gap reports/QA临时报告/验收报告/阶段性文档) - 删除 docs/.hermes/skills 第三方 skills 副本(16 文件) - 删除 skills-lock.json 目录归集: - 根目录仅保留 README.md 索引 - product/ — 产品与架构设计(PRD + ARCHITECTURE + P2设计文档 + AI/企业路线图) - tracking/ — Chatwoot parity 开发跟踪 - requirements/ — M01-M12 模块需求 - plans/ — 历史实现计划 - parity/ — 路由 parity 与前端契约 - qa/ — QA 报告与测试计划 - ops/ — 运维部署 命名规范: - 全小写 kebab-case,禁止全大写文件名 - product/tracking/ops 用 NN- 序号前缀 - requirements 用 MNN- 两位零填充模块号 - plans/qa 用 YYYY-MM-DD- 日期前缀 - requirements M1-M9 零填充为 M01-M09(修复字典序) 同步更新: - backend/cmd/route_parity/main.go 路径默认值 - backend/scripts/parity_frontend_smoke.sh 报告路径 - 所有 docs 内部交叉引用 - .gitignore 排除编译产物 (backend/gochat, backend/route_parity) - 新增迁移 000052/000053 - 前端 WS 相关修改
This commit is contained in:
+7
-9
@@ -8,7 +8,7 @@
|
||||
|
||||
## 一、现状勘误:早期文档中的过时描述
|
||||
|
||||
以下为 `docs/CHANNEL_INTEGRATION_PRIORITIES.md` 及相关早期文档中的过时描述,现已基于代码审查修正:
|
||||
以下为早期渠道集成文档(已清理合并至本文档)中的过时描述,现已基于代码审查修正:
|
||||
|
||||
| 早期文档描述 | 真实实现状态 | 依据 |
|
||||
|---|---|---|
|
||||
@@ -164,7 +164,7 @@ Inbox 模型的 `ChannelConfig` 字段为 JSON text,各渠道有专属 config
|
||||
|
||||
## 四、Chatwoot 渠道功能对比
|
||||
|
||||
基于 `docs/comparison/Gochat-vs-Chatwoot-Full-Comparison.md` 和 `docs/architecture/P2D-渠道抽象层设计.md` 的分析:
|
||||
基于 `docs/product/06-design-channel-abstraction.md` 和 `docs/tracking/01-chatwoot-parity-tracker.md` 的分析:
|
||||
|
||||
### 4.1 Chatwoot 已支持的渠道 vs GoChat 状态
|
||||
|
||||
@@ -303,15 +303,13 @@ fbChannel := accountScoped.Group("/facebook")
|
||||
|
||||
| 文档 | 路径 | 内容 |
|
||||
|---|---|---|
|
||||
| 渠道优先级排序(需修正) | `docs/CHANNEL_INTEGRATION_PRIORITIES.md` | 早期评估,含多处过时描述 |
|
||||
| 渠道抽象层设计 | `docs/architecture/P2D-渠道抽象层设计.md` | Provider 接口设计文档 |
|
||||
| 产品需求文档 | `docs/PRD.md` | M2 收件箱与渠道需求 |
|
||||
| M2 需求 | `docs/requirements/M2-inbox-and-channels.md` | Inbox + Channel 详细需求 |
|
||||
| Chatwoot 对比 | `docs/comparison/Gochat-vs-Chatwoot-Full-Comparison.md` | 竞品功能对比 |
|
||||
| 路由差距分析 | `docs/ROUTE_GAP_ANALYSIS.md` | API 路由差距(含过时描述需修正) |
|
||||
| 渠道抽象层设计 | `docs/product/06-design-channel-abstraction.md` | Provider 接口设计文档 |
|
||||
| 产品需求文档 | `docs/product/01-product-requirements.md` | M2 收件箱与渠道需求 |
|
||||
| M2 需求 | `docs/requirements/M02-inbox-and-channels.md` | Inbox + Channel 详细需求 |
|
||||
| Chatwoot parity 跟踪 | `docs/tracking/01-chatwoot-parity-tracker.md` | 当前对齐进度 |
|
||||
| Provider 接口核心 | `internal/channel/provider.go` | Provider/IncomingMessage/OutgoingMessage 定义 |
|
||||
| Provider 注册表 | `internal/channel/registry.go` | Register()/GetProvider() 实现 |
|
||||
| Bootstrap 接线 | `internal/app/bootstrap.go` (194-324行) | 依赖注入和 Provider 注册 |
|
||||
| Bootstrap 接线 | `internal/app/bootstrap.go` | 依赖注入和 Provider 注册 |
|
||||
| 路由配置 | `internal/router/router.go` | 所有已注册路由 |
|
||||
|
||||
---
|
||||
Reference in New Issue
Block a user