← 中文资源

简体中文版本

运行手册质量评审工作流

让不熟悉的人按手册执行以验证、修复含糊步骤与缺失前提,并从告警链接到对应手册。

阅读英文原文

概述

运行手册的问题在压力下才暴露:前提缺失、命令不精确、期望输出不清,都会让值班者临场猜测。让不熟悉系统的人按手册执行、修复前提与命令、补充决策点与回滚指引、并从每条告警链接到对应手册,可让手册在真正需要时可靠。

关键步骤

  1. 让不熟悉该系统的工程师按手册执行。
  2. 修复缺失前提、精确命令与期望输出。
  3. 补充决策点与回滚指引。
  4. 从每条告警链接到相关手册并保持链接有效。

验证

  • 测试者无需未记录帮助即完成流程。
  • 告警链接解析到正确手册。
  • 步骤含期望输出。
  • 评审与版本有记录。

决策点

应写出精确步骤而非假定熟悉度,压力下假定会失效;手册宜按症状组织,因告警基于症状触发,再交叉链接到根因处置。

适用范围

本条目围绕「运行手册质量评审工作流」给出可复制的步骤、验证方式与常见问题,适合需要按此流程落地的工程团队。执行时请结合自身上下文调整命令与阈值,并在变更前后留存证据,便于后续复核与回滚。

# a good runbook step has an exact command and an expected output
kubectl get pods -n prod | grep -v Running
# expected: no output means all pods are Running