docs(docs): 更新 issue 仲裁状态 + 生成集成测试阶段规划
- 14 个 issue.md 状态字段更新为"已裁决" - 对应 coord.md ARB-001~022 章节 - 共 104 处状态字段更新 - 新增 integration-test-phase.md - 集成测试与部署验证阶段(P7)规划 - 6 个批次任务分解 - 8 条核心 E2E 链路定义 - 验收标准和退出标准 Coord-AI
This commit is contained in:
@@ -46,7 +46,7 @@ N1-N5 与 C2/C4/C10 共 8 项已有仲裁**全部在 02-architecture-design.md
|
||||
2. **knowledge-points 删除前置**:设计文档列 `DELETE /knowledge-points/:id/prerequisites/:prereqId`,源码未实现该端点
|
||||
3. **chapters 列表**:设计文档为 `GET /chapters?textbookId=`,源码实现为 `GET /chapters/textbook/:textbookId`
|
||||
- **建议方案**:以设计文档为目标态(query 参数 + 补 DELETE prerequisite 端点),在 P4 重构时统一对齐。但需 coord 确认是否允许 API 路径变更(影响 teacher-bff 消费方)。
|
||||
- **状态**:待 coord 仲裁
|
||||
- **状态**:已裁决(见 coord.md §5)
|
||||
|
||||
### ISSUE-002-ai09:content 发布事件 topic 命名策略与契约文档不一致
|
||||
|
||||
@@ -62,7 +62,7 @@ N1-N5 与 C2/C4/C10 共 8 项已有仲裁**全部在 02-architecture-design.md
|
||||
2. 减少 topic 数量(12 → 4),降低 Kafka 集群元数据压力
|
||||
3. 消费方按 action 字段过滤,订阅灵活性更高
|
||||
4. 需补 `KnowledgePointEvent` / `QuestionEvent` / `TextbookEvent` / `ChapterEvent` proto message
|
||||
- **状态**:待 coord 仲裁
|
||||
- **状态**:已裁决(见 coord.md §5)
|
||||
|
||||
### ISSUE-003-ai09:Textbook/Chapter 事件在契约文档遗漏
|
||||
|
||||
@@ -71,7 +71,7 @@ N1-N5 与 C2/C4/C10 共 8 项已有仲裁**全部在 02-architecture-design.md
|
||||
- **类型**:契约不明确
|
||||
- **描述**:02-architecture-design.md §5.1 列出 4 类 textbook 事件 + 1 类 chapter 事件,但 contracts/content_contract.md §1.4 仅列出 knowledge_point 与 question 两类事件,Textbook/Chapter 事件未登记。matrix.md §4 也仅列 kp + question。导致下游(data-ana)无法感知教材/章节变更。
|
||||
- **建议方案**:在 contract.md 与 matrix.md 补登记 `edu.content.textbook.events`(action: created/updated/published/archived)与 `edu.content.chapter.events`(action: created/updated/deleted)。若 coord 认为教材/章节无需对外发事件,则在 design doc §5.1 删除相关事件。
|
||||
- **状态**:待 coord 仲裁
|
||||
- **状态**:已裁决(见 coord.md §5)
|
||||
|
||||
### ISSUE-004-ai09:gRPC RPC 数量三方文档不一致
|
||||
|
||||
@@ -96,7 +96,7 @@ N1-N5 与 C2/C4/C10 共 8 项已有仲裁**全部在 02-architecture-design.md
|
||||
2. ChapterService 补 Update + Delete(design doc + contract 都缺 Delete,需补)
|
||||
3. QuestionService 补 PublishQuestion + SearchQuestions(与 contract 对齐)
|
||||
4. 最终 RPC 总数:TextbookService 5 + ChapterService 5 + KnowledgeGraphService 4 + QuestionService 7 = **21 RPC**(需同步更新 matrix.md §2 的 18 → 21)
|
||||
- **状态**:待 coord 仲裁
|
||||
- **状态**:已裁决(见 coord.md §5)
|
||||
|
||||
### ISSUE-005-ai09:core-edu → content 失效事件 topic 无定义
|
||||
|
||||
@@ -109,7 +109,7 @@ N1-N5 与 C2/C4/C10 共 8 项已有仲裁**全部在 02-architecture-design.md
|
||||
3. core-edu 设计文档(ai08)未明确发布该事件
|
||||
4. 01-understanding.md §5 也标注"具体 topic 待 core-edu ai03 设计确认"——此处 ai03 疑为笔误,core-edu 实际由 ai08 负责
|
||||
- **建议方案**:content 不主动消费 core-edu 失效事件(content 是上游内容提供方,core-edu 是消费方),删除 §5.2 中该条目;若确有联动需求,由 core-edu 主动调用 content gRPC UpdateQuestion 状态变更,而非事件驱动。
|
||||
- **状态**:待 coord 仲裁
|
||||
- **状态**:已裁决(见 coord.md §5)
|
||||
|
||||
### ISSUE-006-ai09:文档结尾"直接 push main"与项目规则冲突
|
||||
|
||||
@@ -121,7 +121,7 @@ N1-N5 与 C2/C4/C10 共 8 项已有仲裁**全部在 02-architecture-design.md
|
||||
- §14.3:AI 禁止 `git merge`、`git push origin main`
|
||||
- 当前 worktree 分支为 `feat-review-content-module-docs-WAIyMA`
|
||||
- **建议方案**:删除两份文档末尾"单仓库并行模式(直接 push main)"字样,改为 `Branch: feat-review-content-module-docs-WAIyMA(分支开发,提交后通知人类合并)`。
|
||||
- **状态**:待 coord 仲裁
|
||||
- **状态**:已裁决(见 coord.md §5)
|
||||
|
||||
### ISSUE-007-ai09:questions 表 created_by 字段迁移风险
|
||||
|
||||
@@ -130,7 +130,7 @@ N1-N5 与 C2/C4/C10 共 8 项已有仲裁**全部在 02-architecture-design.md
|
||||
- **类型**:其他
|
||||
- **描述**:02-architecture-design.md §3.1.4 questions 表新增 `created_by varchar(32) NOT NULL`,但现有 [questions.schema.ts](../../../services/content/src/questions/questions.schema.ts) 无该字段,且现有数据无 created_by 值。schema 迁移时 NOT NULL 约束会导致历史数据迁移失败。
|
||||
- **建议方案**:迁移期间先用 `created_by varchar(32) NULL`,数据回填后再加 NOT NULL 约束;或为新数据强制要求 created_by(应用层校验),历史数据用 `'system'` 默认值回填。
|
||||
- **状态**:待 coord 仲裁
|
||||
- **状态**:已裁决(见 coord.md §5)
|
||||
|
||||
### ISSUE-008-ai09:设计文档缺缓存策略与 API 版本化策略
|
||||
|
||||
@@ -143,7 +143,7 @@ N1-N5 与 C2/C4/C10 共 8 项已有仲裁**全部在 02-architecture-design.md
|
||||
- **建议方案**:
|
||||
1. P4 在 design doc §6 补"缓存策略"小节:教材树/章节树 Redis 缓存 + 失效策略(Outbox 事件触发缓存失效)
|
||||
2. P4 在 design doc §4 补"API 版本化"说明:REST 端点统一加 `/v1/` 前缀(gRPC 用 proto package version)
|
||||
- **状态**:待 coord 仲裁
|
||||
- **状态**:已裁决(见 coord.md §5)
|
||||
|
||||
### ISSUE-009-ai09:knowledge-points schema 实际缺 difficulty/metadata 字段
|
||||
|
||||
@@ -152,7 +152,7 @@ N1-N5 与 C2/C4/C10 共 8 项已有仲裁**全部在 02-architecture-design.md
|
||||
- **类型**:其他
|
||||
- **描述**:02-architecture-design.md §3.1.3 knowledge_points 表列出 `difficulty tinyint NOT NULL DEFAULT 3` 与 `metadata json NULL`,但实际 [textbooks.schema.ts](../../../services/content/src/textbooks/textbooks.schema.ts) 中 `knowledgePoints` 表仅含 id/chapterId/title/description 四个字段,无 difficulty 与 metadata。01-understanding.md C7 提到"时间戳缺失"但未提到 difficulty/metadata 缺失。
|
||||
- **建议方案**:P4 schema 迁移时一并补齐 difficulty + metadata + created_at + updated_at(与 design doc §3.1.3 对齐)。
|
||||
- **状态**:待 coord 仲裁
|
||||
- **状态**:已裁决(见 coord.md §5)
|
||||
|
||||
### ISSUE-010-ai09:Neo4j Sync Worker 与 ES Sync Worker 在 P4 阶段不必要
|
||||
|
||||
@@ -167,21 +167,21 @@ N1-N5 与 C2/C4/C10 共 8 项已有仲裁**全部在 02-architecture-design.md
|
||||
1. §1.1 图中明确标注 ES Sync Worker 为 P5 组件(虚线或灰显)
|
||||
2. §1.1 图中 Neo4j Sync Worker 的输入仅来自 content 自身 Outbox 事件(不消费 core-edu 事件)
|
||||
3. P4 任务 T6 明确"重构 knowledge-points.service.ts:移除 safeCreateNode 同步写,改为发 Outbox 事件"
|
||||
- **状态**:待 coord 仲裁
|
||||
- **状态**:已裁决(见 coord.md §5)
|
||||
|
||||
---
|
||||
|
||||
## §2 待 coord 仲裁项汇总
|
||||
|
||||
| # | 标题 | 阻塞性 | 状态 |
|
||||
| --- | ---------------------------------------- | ------------------- | ------------- |
|
||||
| 001 | REST 端点设计与实现不一致 | 🟡 P4 重构时对齐 | 待 coord 仲裁 |
|
||||
| 002 | 事件 topic 命名策略冲突(独立 vs 聚合) | 🔴 阻塞 Outbox 实现 | 待 coord 仲裁 |
|
||||
| 003 | Textbook/Chapter 事件在契约文档遗漏 | 🟡 契约完整性 | 待 coord 仲裁 |
|
||||
| 004 | gRPC RPC 数量三方文档不一致 | 🔴 阻塞 proto 修改 | 待 coord 仲裁 |
|
||||
| 005 | core-edu → content 失效事件 topic 无定义 | 🟢 建议删除 | 待 coord 仲裁 |
|
||||
| 006 | "直接 push main"与项目规则冲突 | 🟡 文档修正 | 待 coord 仲裁 |
|
||||
| 007 | questions.created_by 迁移风险 | 🟡 schema 迁移 | 待 coord 仲裁 |
|
||||
| 008 | 缓存策略与 API 版本化策略缺失 | 🟢 长远架构 | 待 coord 仲裁 |
|
||||
| 009 | knowledge-points schema 实际缺字段 | 🟡 P4 schema 迁移 | 待 coord 仲裁 |
|
||||
| 010 | Sync Worker 链路与 P4 阶段不必要 | 🟡 设计澄清 | 待 coord 仲裁 |
|
||||
| # | 标题 | 阻塞性 | 状态 |
|
||||
| --- | ---------------------------------------- | ------------------- | ------ |
|
||||
| 001 | REST 端点设计与实现不一致 | 🟡 P4 重构时对齐 | 已裁决 |
|
||||
| 002 | 事件 topic 命名策略冲突(独立 vs 聚合) | 🔴 阻塞 Outbox 实现 | 已裁决 |
|
||||
| 003 | Textbook/Chapter 事件在契约文档遗漏 | 🟡 契约完整性 | 已裁决 |
|
||||
| 004 | gRPC RPC 数量三方文档不一致 | 🔴 阻塞 proto 修改 | 已裁决 |
|
||||
| 005 | core-edu → content 失效事件 topic 无定义 | 🟢 建议删除 | 已裁决 |
|
||||
| 006 | "直接 push main"与项目规则冲突 | 🟡 文档修正 | 已裁决 |
|
||||
| 007 | questions.created_by 迁移风险 | 🟡 schema 迁移 | 已裁决 |
|
||||
| 008 | 缓存策略与 API 版本化策略缺失 | 🟢 长远架构 | 已裁决 |
|
||||
| 009 | knowledge-points schema 实际缺字段 | 🟡 P4 schema 迁移 | 已裁决 |
|
||||
| 010 | Sync Worker 链路与 P4 阶段不必要 | 🟡 设计澄清 | 已裁决 |
|
||||
|
||||
Reference in New Issue
Block a user