用途
Runbooks - Structure 用于指导团队创建结构化的运维手册(Runbook),即面向人工操作者的分步操作文档。它适用于故障排查、事件响应、日常维护以及值班工程师参考等场景,目标是让操作步骤清晰、可执行、可验证。
主要能力
该技能围绕 Runbook 的编写与组织提供以下内容:
- 基础结构:给出最小可用 Runbook 的组成,包括概述、前置条件、步骤、验证和回滚(如适用)。
- 综合模板:提供完整的 Markdown 模板,涵盖标题、最后更新时间、负责人、严重级别、预计耗时、概述、使用时机、前置条件、上下文(架构概览与常见原因)、诊断步骤、解决步骤、验证、回滚、后续行动、相关 Runbook、联系信息和修订历史。
- 组织方式:给出目录结构示例,包含 README 索引、templates、services、infrastructure、on-call 等分类。
- 最佳实践:强调清晰具体的步骤、决策树、预期输出和检查清单。
- 常见模式:包含应急响应、例行维护和知识传递三类模式示例。
- 反模式:指出不应省略上下文、不应跳过验证步骤、不应假设读者已具备相关知识。
使用方式
资料中提供了可直接参考的 Markdown 模板与示例,包括诊断步骤中的命令(如 kubectl、aws cloudwatch、psql 等)、决策点写法、验证清单和回滚命令。使用者可依据这些模板和模式编写自己的 Runbook。资料未提供安装命令或具体调用方式。
适用场景
- 为告警(如 high_cpu_usage)或客户报告的问题编写排查手册
- 处理生产事件时的应急响应流程
- 计划性维护窗口的操作步骤
- 值班工程师的参考文档
- 新工程师入职的流程学习与认证
限制
资料未说明该技能的运行环境、依赖、安装方式或收费信息。其内容为文档编写规范与模板,不涉及自动化执行。