Back to Details

devops-runbooks

Compare original and translation side by side

🇺🇸

Original

English
🇨🇳

Translation

Chinese

DevOps Runbooks Skill

DevOps Runbooks 技能

Creates actionable runbooks for operational procedures, incident response, and system maintenance.
为运维流程、事件响应和系统维护创建可执行的运维手册。

What This Skill Does

该技能的功能

  • Creates operational runbooks
  • Documents incident procedures
  • Defines escalation paths
  • Provides troubleshooting guides
  • Documents rollback procedures
  • Captures operational knowledge
  • 创建运维手册
  • 记录事件响应流程
  • 定义升级路径
  • 提供故障排查指南
  • 记录回滚流程
  • 留存运维知识

When to Use

适用场景

  • Incident response planning
  • On-call documentation
  • System maintenance procedures
  • Disaster recovery planning
  • Knowledge transfer
  • 事件响应规划
  • 值班文档编写
  • 系统维护流程制定
  • 灾难恢复规划
  • 知识转移

Reference Files

参考文件

  • references/RUNBOOK.template.md
    - Comprehensive operational runbook format
  • references/RUNBOOK.template.md
    - 全面的运维手册格式模板

Runbook Structure

运维手册结构

  1. Overview - Purpose and when to use
  2. Prerequisites - Access and tools needed
  3. Quick Reference - Key commands and URLs
  4. Procedure - Step-by-step with verification
  5. Rollback - How to revert changes
  6. Troubleshooting - Common issues
  7. Escalation - When and how to escalate
  1. 概述 - 手册用途及适用场景
  2. 前置条件 - 所需权限与工具
  3. 快速参考 - 关键命令与URL
  4. 执行流程 - 带验证步骤的分步指南
  5. 回滚操作 - 如何撤销变更
  6. 故障排查 - 常见问题处理
  7. 升级流程 - 升级的时机与方式

Best Practices

最佳实践

  • Commands must be copy-pasteable
  • Include expected output for each step
  • Document decision points clearly
  • Define rollback at each step
  • Keep procedures current (test regularly)
  • Include escalation contacts
  • 命令需支持直接复制粘贴
  • 为每个步骤添加预期输出
  • 清晰记录决策节点
  • 在每个步骤中明确回滚方案
  • 保持流程更新（定期测试）
  • 包含升级联系人信息