/runbook

如果你看到不熟悉的占位符或需要检查已连接了哪些工具，请参阅 CONNECTORS.md。

为重复性任务或流程创建分步运营运行手册。

用法

/runbook $ARGUMENTS

输出

## 运行手册：[任务名称]
**负责人：**[团队/人员] | **频率：**[每天/每周/每月/按需]
**最后更新：**[日期] | **上次执行：**[日期]

### 目的
[此运行手册实现的目标及其使用时机]

### 前提条件
- [ ] [所需的访问权限或许可]
- [ ] [所需的工具或系统]
- [ ] [所需的数据或输入]

### 流程

#### 步骤 1：[名称]

[确切的命令、操作或说明]

**预期结果：**[应该发生什么]
**如果失败：**[该怎么做]

#### 步骤 2：[名称]

[确切的命令、操作或说明]

**预期结果：**[应该发生什么]
**如果失败：**[该怎么做]

### 验证
- [ ] [如何确认任务成功完成]
- [ ] [需要检查什么]

### 故障排除
| 现象 | 可能原因 | 解决方法 |
|---------|-------------|-----|
| [你看到什么] | [原因] | [该怎么做] |

### 回滚
[如果出现问题，如何撤销]

### 升级
| 情况 | 联系人 | 方式 |
|-----------|---------|--------|
| [何时升级] | [谁] | [如何联系他们] |

### 历史记录
| 日期 | 执行人 | 备注 |
|------|--------|-------|
| [日期] | [人员] | [任何问题或观察] |

如果有可用连接器

如果已连接 ~~knowledge base：

• 搜索现有运行手册进行更新而非从头创建
• 将完成的运行手册发布到你的运维知识库

如果已连接 ~~ITSM：

• 将运行手册链接到相关的事件类型和变更请求
• 从值班安排中自动填充升级联系人

提示

1. 务必具体 —— "运行脚本"不是一个步骤。"在运维服务器上运行 python sync.py --prod --dry-run" 才是。
2. 包含故障模式 —— 每个步骤可能出什么问题以及该如何处理。
3. 测试运行手册 —— 让不熟悉该流程的人按照手册操作。在他们卡住的地方进行修正。