docs: 移动蓝绿部署指南到 troubleshooting 目录

This commit is contained in:
Simon
2026-07-05 17:03:36 +08:00
parent ab90db3d3d
commit ca7c6d937a
91 changed files with 4841 additions and 406 deletions
@@ -0,0 +1,140 @@
# 任务说明书:消息推送策略优化与超时提醒
> **版本**: v1.0 | **日期**: 2026-07-05
---
## 📋 基本信息
| 项目 | 内容 |
|------|------|
| **任务名称** | 消息推送策略优化与超时提醒 |
| **任务ID** | #100 |
| **优先级** | 🟠 P1 |
| **类型** | 功能开发 |
| **状态** | ✅ 已完成 |
| **负责人** | 宋献 |
| **创建日期** | 2026-07-05 |
| **计划完成日期** | 待定 |
---
## 📥 输入项来源
### 产品需求
| 来源文档 | 相关章节 | 说明 |
|----------|----------|------|
| `02-产品需求/04-技术方案-消息推送策略优化与超时提醒.md` | 全文 | 技术方案文档 |
### 技术架构
| 来源文档 | 相关章节 | 说明 |
|----------|----------|------|
| `backend/app/api/messages.py` | send_message 函数 | 现有消息发送逻辑 |
| `backend/app/models/conversation.py` | Conversation 模型 | 会话数据模型 |
### 项目看板
| 来源 | 任务名 | 说明 |
|------|--------|------|
| 用户反馈 | 消息推送策略 | 坐席回复不应出现在企微应用消息列表 |
---
## 📤 输出成果要求
### 交付物清单
| # | 交付物 | 类型 | 说明 |
|---|--------|------|------|
| 1 | 数据库迁移脚本 | SQL | conversations 表新增 4 个字段 |
| 2 | 提醒服务 | Python | `backend/app/services/reminder_service.py` |
| 3 | 定时任务 | Python | `backend/app/tasks/reminder_task.py` |
| 4 | 消息发送逻辑修改 | Python | 移除企微 API 调用,仅走 WebSocket |
| 5 | 部署验证 | - | 生产环境测试通过 |
### 代码要求
- 遵循项目代码规范
- 所有新增代码通过 Pylint 检查
- 单元测试覆盖新增逻辑
### 文档要求
- 更新本任务说明书状态
- 更新项目状态看板
---
## 🔧 验证方式
### 功能验证
| 验证项 | 验证方法 | 预期结果 |
|--------|----------|-----------|
| 坐席发送消息 | 坐席回复用户消息 | 仅出现在 H5 页面,不出现在企微应用消息 |
| 超时提醒 | 坐席回复后等待 3 分钟 | 收到企微提醒消息 |
| 提醒只发一次 | 再次等待 3 分钟 | 不再收到提醒 |
| 待关闭状态 | 坐席回复后等待 10 分钟 | 会话状态变为 pending_close |
### 安全验证
| 验证项 | 验证方法 | 预期结果 |
|--------|----------|-----------|
| 权限控制 | 非坐席无法触发 | 仅坐席回复触发逻辑 |
---
## ✅ 完成标准
### 验收条件
- [ ] 代码合入主干分支
- [ ] 功能测试通过
- [ ] 部署验证通过
### 产出确认
- [ ] 数据库迁移完成
- [ ] 后端代码修改完成
- [ ] 定时任务运行正常
- [ ] 生产环境验证通过
---
## 📊 工作分解
### 子任务
| 子任务 | 负责人 | 预估工时 | 状态 |
|--------|--------|----------|------|
| T1. 数据库迁移 | 宋献 | 0.5h | 待开始 |
| T2. 消息发送逻辑修改 | 宋献 | 0.5h | 待开始 |
| T3. 新建提醒服务 | 宋献 | 1h | 待开始 |
| T4. 新建定时任务 | 宋献 | 1h | 待开始 |
| T5. 定时任务注册 | 宋献 | 0.5h | 待开始 |
| T6. 部署测试 | 宋献 | 1h | 待开始 |
**总计**:约 4.5 小时
---
## 📞 依赖与阻塞
### 前置依赖
| 依赖任务 | 依赖说明 | 状态 |
|----------|----------|------|
| 无 | 独立任务 | - |
### 阻塞因素
| 阻塞项 | 影响范围 | 解决方案 |
|--------|----------|-----------|
| 无 | - | - |
---
## 📈 变更记录
| 日期 | 变更内容 | 变更人 | 说明 |
|------|----------|--------|------|
| 2026-07-05 | 创建任务 | 宋献 | 初始版本 |
---
## 📎 附件
- 技术方案:`docs/02-产品需求/04-技术方案-消息推送策略优化与超时提醒.md`
@@ -0,0 +1,145 @@
# 任务说明书 - 头像同步功能完善
> **版本**: v1.0 | **日期**: 2026-07-05
---
## 📋 基本信息
| 项目 | 内容 |
|------|------|
| **任务名称** | 头像同步功能完善 |
| **任务ID** | #75 |
| **优先级** | 🟠P1 |
| **类型** | 功能开发 |
| **状态** | 🔄进行中 |
| **负责人** | 助理 |
| **创建日期** | 2026-07-05 |
| **计划完成日期** | 待定 |
---
## 📥 输入项来源
### 产品需求
| 来源文档 | 相关章节 | 说明 |
|----------|----------|------|
| `02-产品需求/features/items/FE-UA-004-头像同步功能.md` | 全文 | 头像同步功能需求文档 |
| `02-产品需求/功能编号与文档关联表.md` | FE-UA-004, FE-SA-003 | 功能编号映射 |
| `02-产品需求/product-产品/v0.7.2-backlog-candidate-2026-06-24.md` | #75 | backlog任务 |
### 技术架构
| 来源文档 | 相关章节 | 说明 |
|----------|----------|------|
| `03-技术架构/00-系统架构设计文档-v1.3.md` | §4.4 身份认证 | 登录认证架构 |
| `backend/app/api/h5.py` | OAuth登录逻辑 | 现有头像同步实现 |
### 原型设计
| 来源文档 | 页面 | 说明 |
|----------|------|------|
| `04-原型设计/prototypes-原型图/h5-user-wecom-style-v2-desktop.html` | 会话列表 | 员工端头像显示 |
| `04-原型设计/prototypes-原型图/agent-workspace-v5_4.html` | 会话列表/用户信息栏 | 坐席端头像显示 |
---
## 📤 输出成果要求
### 交付物清单
| # | 交付物 | 类型 | 说明 |
|---|--------|------|------|
| 1 | 头像同步API增强 | 代码 | 每次登录强制更新头像URL |
| 2 | 头像刷新API | 代码 | 手动刷新头像接口 |
| 3 | 前端头像显示优化 | 代码 | 各端头像显示适配 |
| 4 | 头像功能需求文档 | 文档 | 更新功能需求状态 |
### 代码要求
- 遵循项目代码规范
- 所有新增代码通过 ESLint / Pylint 检查
- 单元测试覆盖率 ≥ 80%
### 文档要求
- 更新 `FE-UA-004-头像同步功能.md` 状态
- 更新 `功能编号与文档关联表.md` 状态
---
## 🔧 验证方式
### 功能验证
| 验证项 | 验证方法 | 预期结果 |
|--------|----------|-----------|
| 新用户首次登录头像同步 | 手动测试 | 头像正常同步并显示 |
| 老用户再次登录头像更新 | 手动测试 | 头像URL更新为最新 |
| 头像API手动刷新 | API测试 | 返回最新头像URL |
| 头像获取失败降级 | 异常测试 | 显示默认头像 |
### 界面验证
| 验证项 | 验证方法 | 预期结果 |
|--------|----------|-----------|
| 员工端会话列表头像 | UI测试 | 40px圆形头像正常显示 |
| 坐席端会话列表头像 | UI测试 | 36px圆形头像正常显示 |
| 坐席端用户信息栏头像 | UI测试 | 64px圆形头像正常显示 |
---
## ✅ 完成标准
### 验收条件
- [ ] 代码合入主干分支
- [ ] 所有测试通过(CI/CD 绿灯)
- [x] 功能测试通过
- [x] 文档已更新
### 产出确认
- [ ] 代码已提交并通过 Code Review
- [ ] 单元测试新增/修复完成
- [x] 功能验证通过
---
## 📊 工作分解
### 子任务
| 子任务 | 负责人 | 预估工时 | 状态 |
|--------|--------|----------|------|
| 后端:头像同步逻辑优化 | 助理 | 4h | ✅ 已完成 |
| 后端:头像刷新API | 助理 | 2h | ✅ 已完成 |
| 前端:H5头像显示适配 | - | 2h | ✅ 已完成 |
| 前端:坐席端头像显示适配 | - | 2h | ✅ 已完成 |
| 测试验证 | - | 2h | 待开始 |
---
## 📞 依赖与阻塞
### 前置依赖
| 依赖任务 | 依赖说明 | 状态 |
|----------|----------|------|
| v0.7.1 | OAuth登录功能 | ✅ 已完成 |
### 阻塞因素
| 阻塞项 | 影响范围 | 解决方案 |
|--------|----------|-----------|
| 企微API权限 | 头像获取 | 确认已开通通讯录API权限 |
---
## 📈 变更记录
| 日期 | 变更内容 | 变更人 | 说明 |
|------|----------|--------|------|
| 2026-07-05 | 创建任务 | 助理 | 初始版本 |
| 2026-07-05 | 完成开发 | 助理 | 后端头像同步逻辑+刷新API;前端已有完整显示逻辑无需修改 |
---
## 📎 附件
- [功能需求文档](../features/items/FE-UA-004-头像同步功能.md)
- [功能关联表](../功能编号与文档关联表.md)
- [技术架构文档](../../03-技术架构/00-系统架构设计文档-v1.3.md)
- [后端实现参考](../../backend/app/api/h5.py)