Files
wecom_it_smart_desk/docs/10-任务说明/P1-04-排查流程图文档化.md
T

2.4 KiB
Raw Blame History

P1-04: 排查流程图文档化

任务概述

项目 内容
需求ID #86
优先级 P1
状态 已完成
预估工时 3h
完成时间 2026-07-06

背景

排查流程图目前存储在数据库中(JSON 格式),通过管理后台的流程图编辑器进行维护。需要创建文档说明其数据结构和使用方式。

实施方案

创建综合故障排查指南文档,涵盖常见问题的排查步骤。

已创建文档

标准故障排查手册(原 13-故障排查指南已并入)

包含以下章节:

  1. 服务访问问题

    • 页面 500 错误排查
    • 502 Bad Gateway 排查
  2. 登录认证问题

    • 企微 OAuth 登录失败
    • Token 过期
    • 坐席 OTP 验证失败
  3. 消息通信问题

    • 消息发送失败
    • WebSocket 断连
  4. 后端服务问题

    • 后端启动失败
    • 数据库连接失败
  5. 数据库问题

    • 数据库迁移失败
    • 数据查询慢
  6. 前端显示问题

    • 静态资源 404
    • 头像不显示

验收标准

  • 明确任务范围
  • 创建相应文档

实施步骤

  1. 调研现有流程图存储方式
  2. 确认任务范围(选项 A:创建故障排查指南)
  3. 创建文档(已并入 标准故障排查手册

2026-07-07 整合增强 (v1.0)

原 9 份故障排查散落文档(快速诊断-500 / 服务器端跑诊断 / 13-故障排查指南 / 04+12 修复记录 / 502-BadGateway / 通讯链路诊断方案 / deploy/02-故障排查 / 03-调试验证指南)已合并为 09-部署运维/00-标准故障排查手册.md(v1.0) 作为唯一入口,9 份源文档删除、13 处断链修复、mkdocs.yml 新增「故障排查」导航分区。

手册新增内容(相对初版):

  • §0 文档说明 + 验证完成硬规则(宣布修复前必须提供真实浏览器截图/端到端证据)
  • §1 三步隔离决策树(nginx 可达性 → 后端直连 → Redis PING
  • §4 案例库新增 CASE-20260707-01(管理后台登录"网络连接失败" = Redis 密码 URL 解析挂起)
  • §5 端到端验证标准(并入调试验证指南)

经验固化:项目 MEMORY.md「⚠️ 生产环境地雷」+「故障排查文档(单一入口)」;用户级 Skill deploy-troubleshoot;用户级 MEMORY.md「验证完成硬规则」。