跳转至

管理员操作手册目录(Admin Manual)

目录编号:DOC-OPS-AM 版本:V1.0 创建日期:2026-08-11 维护人:听云(WCL) / TL 保密级别:🟢 可公开发布(不含密钥/账号/内部 IP) 关联文档WCL 工作手册 §1.2 标准化文档 ①PJM §3.5.2 RACI 对齐凭据管理目录客服服务工作手册DIP1 生产环境管理员操作手册


一、目录定位

本目录是听云(WCL)维护的管理员操作手册,承担 V1.2 工作手册 §1.2「标准化文档 ①」职责。文档描述日常运维 SOP、部署流程、监控告警、故障排查、备份恢复、安全审计等操作步骤,作为听云执行运维工作的标准化依据,亦供 TL 与未来运维人员参考。

1.1 核心定位

维度 说明
存储内容 流程性文档(操作步骤、SOP、检查清单)
服务对象 听云(WCL)执行运维 + TL 评审 + 未来运维人员交接
覆盖范围 本项目全部子项目(DIP1 / 未来 DIP2 / ...)的通用运维流程
公开属性 ✅ 可公开(不含密钥/账号/内部 IP,可同步至公开文档仓)

1.2 与子项目操作手册的关系

文档 定位 关系
本目录(admin-manual/) 通用运维流程 SOP 跨子项目复用
DIP1-OPS-生产环境管理员操作手册 DIP1 专属操作手册 子项目细节,引用本目录 SOP

分工原则:本目录定义"如何做"的通用流程(如"部署流程的 SOP"),子项目操作手册定义"做什么"的具体配置(如"DIP1 部署的环境变量清单")。


二、目录结构与文件清单

ops/admin-manual/                       # 管理员操作手册目录(可公开)
├── README.md                           # 本文件(目录索引 + 手册导航)
├── daily-ops-sop.md                    # 日常运维 SOP(巡检/健康检查/常规操作)
├── deployment-guide.md                 # 部署流程(首次部署/迭代部署/回滚)
├── monitoring-alerting.md              # 监控告警(指标/规则/响应)
├── incident-response.md                # 故障排查(分级/定位/修复/复盘)
├── backup-recovery.md                  # 备份恢复(策略/频率/演练)
└── security-audit.md                   # 安全审计(密钥轮换/访问审计/合规检查)

2.1 文件用途说明

文件 用途 更新频率
README.md 目录索引 + 手册导航 版本升级时
daily-ops-sop.md 日常运维 SOP:巡检/健康检查/常规操作 每月评审
deployment-guide.md 部署流程:首次部署/迭代部署/回滚 SOP 每次重大部署后
monitoring-alerting.md 监控告警:指标定义/告警规则/响应流程 每月评审
incident-response.md 故障排查:分级/定位/修复/复盘 SOP 每次重大故障后
backup-recovery.md 备份恢复:策略/频率/恢复演练 SOP 每季度评审
security-audit.md 安全审计:密钥轮换/访问审计/合规检查 每季度评审

2.2 文档使用指引

角色 推荐阅读顺序
新任运维 README → daily-ops-sop → monitoring-alerting → deployment-guide
听云日常 daily-ops-sop(每日) + monitoring-alerting(实时)
听云部署 deployment-guide → backup-recovery(部署前备份) → daily-ops-sop(部署后验证)
故障响应 incident-response → monitoring-alerting → security-audit(如涉安全)
TL 评审 security-audit → backup-recovery → incident-response

三、手册维护机制

3.1 评审频率(对齐 WCL 工作手册 §2.3)

文档 评审频率 评审人
全部文档 每次重大运维事件后更新 WCL 编写 + TL 评审
daily-ops-sop.md 至少每月评审 WCL + TL
monitoring-alerting.md 至少每月评审 WCL + TL
incident-response.md 每次重大故障后必更新 WCL + TL
security-audit.md 每季度全量评审 WCL + TL
backup-recovery.md 每季度全量评审 + 每次恢复演练后 WCL + TL

3.2 文档自主权

听云(WCL)对本目录下的文件清单、命名、组织方式享有自主决定权(对齐 PJM §3.5.2 + WCL 工作手册 V1.2 §二)。TL 仅评审内容正确性,非文件结构审批。

3.3 版本规范

  • 每份文档独立维护版本号(V1.0 / V1.1 / ...)
  • 每次修订在文末「修订记录」表追加一行
  • 重大变更升级主版本号(V1.0 → V2.0),小修订升子版本号(V1.0 → V1.1)

四、与其他目录的协作

4.1 与 private/credentials/ 的协作

协作点 说明
配置引用 本目录的 SOP 中引用凭据变量名(如 JWT_SECRET),不记录明文
轮换操作 security-audit.md 定义轮换操作步骤,private/credentials/rotation-schedule.md 定义轮换计划
越权防护 本目录所有涉及凭据的操作均标注"听云不持有明文,由 TL 执行"

4.2 与 worklog/ 的协作

协作点 说明
操作记录 本目录 SOP 执行后,须在 worklog/ 记录 OWLG
故障复盘 incident-response.md 复盘结论同步至 OWLG
TL 同步 重大事件由 TL 同步至主仓 WLG

4.3 与 service-manual/ 的协作

协作点 说明
故障升级 客服工单如涉生产故障,service-manual 升级至本目录 incident-response
SLA 对齐 本目录故障响应 SLA 与 service-manual 工单 SLA 对齐

五、修订记录

版本 日期 修订人 修订内容
V1.0 2026-08-11 DT 初始化管理员操作手册目录;建立 7 份文档框架(README + 日常运维 + 部署 + 监控 + 故障 + 备份 + 安全);定义评审频率与文档自主权

本目录为听云(WCL)管理员操作手册,可公开发布。对齐 WCL 工作手册 V1.2 §1.2 标准化文档 ① + PJM §3.5.2