Back to Details

runbook

Compare original and translation side by side

🇺🇸

Original

English
🇨🇳

Translation

Chinese

/runbook

/runbook

If you see unfamiliar placeholders or need to check which tools are connected, see CONNECTORS.md.
Create a step-by-step operational runbook for a recurring task or procedure.
如果你看到不熟悉的占位符或需要查看已连接的工具，请参阅CONNECTORS.md。
为重复性任务或流程创建分步运维手册。

Usage

使用方法

/runbook $ARGUMENTS
/runbook $ARGUMENTS

Output

输出示例

markdown
undefined
markdown
undefined

Runbook: [Task Name]

Runbook: [任务名称]

Owner: [Team/Person] | Frequency: [Daily/Weekly/Monthly/As Needed] Last Updated: [Date] | Last Run: [Date]
负责人: [团队/个人] | 执行频率: [每日/每周/每月/按需执行] 最后更新时间: [日期] | 最后执行时间: [日期]

Purpose

目的

[What this runbook accomplishes and when to use it]
[本手册的作用及适用场景]

Prerequisites

前置条件

  • [Access or permission needed]
  • [Tool or system required]
  • [Data or input needed]
  • [所需权限或访问权限]
  • [所需工具或系统]
  • [所需数据或输入信息]

Procedure

执行步骤

Step 1: [Name]

步骤1: [步骤名称]

[Exact command, action, or instruction]
Expected result: [What should happen] If it fails: [What to do]
[精确的命令、操作或指令]
预期结果: [应出现的结果] 若执行失败: [对应的处理措施]

Step 2: [Name]

步骤2: [步骤名称]

[Exact command, action, or instruction]
Expected result: [What should happen] If it fails: [What to do]
[精确的命令、操作或指令]
预期结果: [应出现的结果] 若执行失败: [对应的处理措施]

Verification

验证步骤

  • [How to confirm the task completed successfully]
  • [What to check]
  • [如何确认任务执行成功]
  • [需要检查的内容]

Troubleshooting

故障排查

SymptomLikely CauseFix
[What you see][Why][What to do]
症状可能原因解决方法
[你观察到的现象][原因][处理方法]

Rollback

回滚操作

[How to undo this if something goes wrong]
[若出现问题，如何撤销本次操作]

Escalation

升级处理

SituationContactMethod
[When to escalate][Who][How to reach them]
场景联系人联系方法
[需要升级处理的情况][联系人][联系途径]

History

执行历史

DateRun ByNotes
[Date][Person][Any issues or observations]
undefined
日期执行人备注
[日期][个人][遇到的问题或观察到的情况]
undefined

If Connectors Available

已连接连接器时的功能

If ~~knowledge base is connected:
  • Search for existing runbooks to update rather than create from scratch
  • Publish the completed runbook to your ops wiki
If ~~ITSM is connected:
  • Link the runbook to related incident types and change requests
  • Auto-populate escalation contacts from on-call schedules
若已连接~~knowledge base：
  • 搜索现有运维手册进行更新，而非从头创建
  • 将完成的运维手册发布到运维维基
若已连接~~ITSM：
  • 将运维手册关联至相关事件类型和变更请求
  • 从值班计划中自动填充升级处理联系人

Tips

小贴士

  1. Be painfully specific — "Run the script" is not a step. "Run 
    python sync.py --prod --dry-run
    from the ops server" is.
  2. Include failure modes — What can go wrong at each step and what to do about it.
  3. Test the runbook — Have someone unfamiliar with the process follow it. Fix where they get stuck.
  1. 务必极其具体 —— "运行脚本"不是一个合格的步骤。"在运维服务器上执行
    python sync.py --prod --dry-run
    "才是。
  2. 包含故障场景 —— 记录每个步骤可能出现的问题及对应的解决方法。
  3. 测试运维手册 —— 让不熟悉该流程的人按照手册执行，修正他们遇到阻碍的地方。