simon/wecom_it_smart_desk
1
0
Fork 0
Code Issues Pull Requests 1 Actions Packages Projects Releases Wiki Activity

chore(docs): docs/ 目录全面重新编号 + 重组

Browse Source 
**重构前**（旧编号 02-11）：
- docs/02-产品需求/      → 00 产品规划/PRD
- docs/03-技术架构/      → 01-05 子目录散落
- docs/04-原型设计/      → 01-02 产品设计（HTML 原型）
- docs/05-原型设计/      → screens/
- docs/06-测试素材/      → 02-E2E / 03-功能 / 04-版本测试
- docs/07-项目管理/      → 任务说明书/日报/计划
- docs/08-安全审计/      → 审计报告
- docs/09-堡垒运维/      → toolbox / deploy
- docs/10-项目管理/      → 任务说明书（重复）
- docs/11-历史归档/      → deploy-nas-archived

**重构后**（新编号 00-07，语义化）：
- docs/00-产品开发流程与文档管理规范.md
- docs/00-版本迭代总览.md
- docs/01-产品文档/      （PRD/原型/认证/会话/AI 服务/坐席/集成）
- docs/02-技术文档/      （技术方案/架构图/重构记录/前端改造/实现配置）
- docs/03-测试文档/      （E2E/功能用例/版本报告/缺陷单）
- docs/04-运维文档/      （部署运维/运维指南）
- docs/05-运营文档/      （品牌推广/用户手册）
- docs/06-安全审计/      （审计报告）
- docs/07-项目管理/      （任务说明书/日报/计划/看板）

**净收益**：
- 目录编号与产品文档管理规范对齐（按文档阶段 01-07 编号）
- 消除 02-产品需求 与 10-项目管理 的编号重叠
- 子目录按文档类型分组（如 01-产品文档/00-产品规划、01-产品文档/01-认证与登录）
- 把运维/安全/项目管理从 0X 散落改为 04/06/07

合计 494 文件 + 78495 行 / - 14076 行
This commit is contained in:
Simon
2026-08-03 18:46:55 +08:00
parent 3a44141eac
commit 44e77dcb0e
494 changed files with 78494 additions and 14075 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/04-运维文档/部署运维/deploy/01-部署指南.md
+182
View File
@@ -0,0 +1,182 @@
# 智能IT服务台 - 部署指南
> **最后更新**：2026-07-05
> **目标服务器**：`10.90.5.110`
> **域名**：`itsupport.servyou.com.cn`
---
## 目录
1. [部署流程](#一部署流程)
2. [蓝绿部署](#二蓝绿部署)
3. [故障排查](#三故障排查)
4. [回滚方案](#四回滚方案)
---
## 一、部署流程
### 1.1 前置条件
| 条件 | 状态 | 验证命令 |
|------|------|---------|
| Linux 服务器 10.90.5.110 | ✅ 已确认 | - |
| Docker 已安装 | ✅ 已确认 | `docker --version` |
| 域名解析 | ✅ 已配置 | `nslookup itsupport.servyou.com.cn` |
| 堡垒机可访问 | ✅ 已配置 | `ssh -p 2222 user@10.212.189.210` |
### 1.2 快速部署命令
```bash
# 1. 进入部署目录
cd /opt/wecom-it-desk
# 2. 拉取最新代码（可选）
git pull origin main
# 3. 构建并启动
docker compose up -d --build
# 4. 检查状态
docker ps
```
### 1.3 一键部署（生产环境）
详见 [10-一键部署操作包-v0.7.0.md](./10-一键部署操作包-v0.7.0.md)
### 1.4 部署后验证
```bash
# 检查容器状态
docker ps
# 检查 API 健康
curl https://itsupport.servyou.com.cn/api/health
# 检查日志
docker logs wecom_it_backend --tail 50
```
---
## 二、蓝绿部署
### 2.1 什么是蓝绿部署
蓝绿部署通过维护两套环境（Blue/Green）实现零停机部署和快速回滚。
### 2.2 部署 Green 环境
```bash
cd /opt/wecom-it-desk
# 构建并启动 Green 环境
docker-compose -f docker-compose-green.yml up -d
# 验证 Green 环境
curl http://localhost:5002/health
```
### 2.3 切换流量
```bash
# 切换到 Green
sed -i 's/wecom_it_backend:8000/wecom_it_backend_green:8000/' /opt/wecom-it-desk/nginx/nginx.conf
docker restart wecom_it_nginx
# 切换回 Blue（回滚）
sed -i 's/wecom_it_backend_green:8000/wecom_it_backend:8000/' /opt/wecom-it-desk/nginx/nginx.conf
docker restart wecom_it_nginx
```
### 2.4 端口说明
| 端口 | 服务 |
|------|------|
| 80/443 | Nginx (生产入口) |
| 5002 | Backend (Green) |
| 5080 | Nginx (Green 测试) |
---
## 三、故障排查
### 3.1 常见问题
#### 502 Bad Gateway
1. 检查后端容器是否运行
```bash
docker ps | grep backend
```
2. 检查后端日志
```bash
docker logs wecom_it_backend --tail 100
```
3. 重启后端
```bash
docker restart wecom_it_backend
```
#### 500 错误
详见 [标准故障排查手册](../00-标准故障排查手册.md)
#### 通讯链路问题
详见 [标准故障排查手册](../00-标准故障排查手册.md)
### 3.2 健康检查
```bash
# 后端
curl http://localhost:8000/health
# Nginx
curl http://localhost/api/health
```
---
## 四、回滚方案
### 4.1 紧急回滚
如果部署后出现严重问题，立即执行：
```bash
# 1. 停止新版本容器
docker stop wecom_it_backend_green
# 2. 切换回原环境
sed -i 's/wecom_it_backend_green:8000/wecom_it_backend:8000/' /opt/wecom-it-desk/nginx/nginx.conf
docker restart wecom_it_nginx
```
### 4.2 版本回滚
如需回滚到之前版本：
```bash
# 1. 停止当前版本
docker stop wecom_it_backend
# 2. 重新构建指定版本
git checkout <版本标签>
docker build -t wecom-it-desk-backend:<版本> ./backend
# 3. 启动
docker run -d --name wecom_it_backend wecom-it-desk-backend:<版本>
```
---
## 相关文档
- [10-一键部署操作包-v0.7.0.md](./10-一键部署操作包-v0.7.0.md)
- [蓝绿部署指南.md](./蓝绿部署指南.md)
- [标准故障排查手册](../00-标准故障排查手册.md)
docs/04-运维文档/部署运维/deploy/03-版本记录.md
+152
View File
@@ -0,0 +1,152 @@
# 智能IT服务台 - 版本记录
> **最后更新**：2026-07-13
---
## 版本历史
### v0.7.3 (2026-07-12~13)
**更新内容**：
1. **AI 对话链路全栈改造 Phase 1-6**（#59-#69）
- Dify Prompt JSON 输出 + 后端 blocking + JSON 解析 + 双 WS 推送
- 审批关键词收窄（~40→~25）+ 两级分类 Prompt v4.0 + 删除前端 checkApprovalIntent
- WS 扩展（ai_thinking + dynamic_recommend）+ MessageBubble ai_structured 渲染 + RightPanel v2
- VisionService 接入（图片分析 + 5秒消息融合）+ 降级策略
- 坐席端 ai_thinking 指示器 + ai_structured/byod_card 渲染
- diagnosis_stage 字段 + response_time_ms 计时 + 慢响应告警
2. **上下文感知智能诊断→修复闭环**
- 三层诊断（API→Script→AI）+ 三段排队（VIP→info_locked→not locked）
- 答题插队 + 五场景关闭 + 迁移 052（6表+6列）
3. **坐席端布局优化 v2.0**
- QuickReplyBar L1+L2 悬浮 / ReplyBox 左右分区 / 右栏 260↔560px
- 键盘快捷键 v2.3（纯数字路由 / ESC 分层撤销 / IME 守卫）
4. **知识库迭代 3**
- 分诊交互 + 拓扑预览（ECharts）+ 代答排除（4种匹配器）+ 迁移 051
5. **H5 v4 人工坐席交互改造**（#116）
- 三态文案统一"人工坐席" / 按钮位置上移 / 删除 CallAgentModal 弹窗
- 截图提示改版 / 移动端 CSS 隐藏 / DB 同步 funny_phrases 表
6. **部署路径修正**
- 确认服务器项目根路径 `/opt/wecom-it-desk/`
- 所有前端 dist 均为 ro bind mount，只能在宿主机源路径操作
**部署方式**：后端 `docker compose restart backend` / 前端宿主机 tar 解压 + `nginx -s reload`
**验证**：JS hash 更新确认 / JS 包内容检查 / API 200 / Nginx healthy
---
### v0.7.1 (2026-06-23)
**更新内容**：
- OTP 二次验证功能上线
- 扫码登录优化
- 安全性增强
**部署包**：[10-一键部署操作包-v0.7.0.md](./10-一键部署操作包-v0.7.0.md)
**相关文档**：
- [07-扫码登录OTP部署指南-v0.7.0.md](./07-扫码登录OTP部署指南-v0.7.0.md)
- [06-OTP二次验证实现.md](./06-OTP二次验证实现.md)
---
### v0.7.0 (2026-06-16)
**更新内容**：
- 消息推送策略优化
- 超时提醒功能
- 头像同步功能
**部署包**：[一键部署操作包-v0.7.0.md](./一键部署操作包-v0.7.0.md)
---
### v0.6.x (历史版本)
详见 [03-RELEASE-NOTES-v0.7.1-20260623.md](./03-RELEASE-NOTES-v0.7.1-20260623.md)
---
## 问题修复记录
### 2026-07-26
- H5 选项交互全链路修复（CASE-20260726-01~08）：白屏/编码损坏/Pinia `.value`/UUID 排序/轮询去重/坐席可见性等 8 个连环问题
- 详见 [标准故障排查手册](../00-标准故障排查手册.md) §4 CASE-20260726-01~08
### 2026-07-25
- H5 始终显示坐席在线 — WS 断连查询字段不匹配（CASE-20260725-01）
- H5 用户端收不到 AI 回复 — WebSocket 推送 datetime 序列化失败（CASE-20260725-02）
- 详见 [标准故障排查手册](../00-标准故障排查手册.md) §4
### 2026-07-24
- H5 选项选择消息重复 — 前端本地 message_id 与后端不同致去重失效（CASE-20260724-01）
- 详见 [标准故障排查手册](../00-标准故障排查手册.md) §4
### 2026-07-23
- H5 AI 回复显示 `[object Object]` — Dify 原生 API 超时回退代理（CASE-20260723-01）
- 详见 [标准故障排查手册](../00-标准故障排查手册.md) §4
### 2026-07-16
- 员工端 /h5/ 404 — nginx 反向代理配置错误（CASE-20260716-01）
- 详见 [标准故障排查手册](../00-标准故障排查手册.md) §4
### 2026-07-15
- 员工端审批"审批模板ID不正确" — 企微审批模板失效，改用 ITSM（CASE-20260715-01）
- 详见 [标准故障排查手册](../00-标准故障排查手册.md) §4
### 2026-07-14
- 坐席端 403 — 前端 bind mount 未生效（CASE-20260714-01）
- 员工端 /h5/ 404 — nginx 配置错误（CASE-20260714-02）
- 详见 [标准故障排查手册](../00-标准故障排查手册.md) §4
### 2026-07-13
- H5 v4 部署路径修正（`/opt/wecom-it-desk/frontend-h5/dist` ro bind mount）
- 服务器 Docker 挂载配置与本地仓库不一致问题定位
### 2026-07-05
- Nginx upstream 配置修复
- 蓝绿部署流程完善
详见 [标准故障排查手册](../00-标准故障排查手册.md)
### 2026-06-13
- H5 用户端报错修复
- 后端启动问题修复
详见 [标准故障排查手册](../00-标准故障排查手册.md)
---
## 版本号规则
| 位置 | 规则 | 示例 |
|------|------|------|
| 前端 | v主.次.修订 | v1.5.0 |
| 后端 | v主.次.修订 | v0.7.1 |
| 部署包 | v主.次.发布日期 | v0.7.0-20260623 |
---
## 升级路径
### 从 v0.6.x 升级到 v0.7.x
1. 备份数据
2. 执行一键部署
3. 验证功能
4. 监控日志
### 版本回滚
详见 [01-部署指南.md](./01-部署指南.md) 中的回滚方案