Runbook Creation

aj-geddes/useful-ai-prompts/skills/runbook-creation

作者 aj-geddes3f5182cfd739无许可证355 个星标收录于 2026年10月8日更新于 2026年10月8日仓库7个月前更新

Create operational runbooks, playbooks, standard operating procedures (SOPs), and incident response guides. Use when documenting operational procedures, on-call guides, or incident response processes.

AI 生成的概览

创建运维手册、标准操作流程和事件响应指南,包含分步操作步骤。

功能
生成结构化的运维手册,涵盖事件响应、标准操作流程、值班手册、系统维护、灾难恢复和升级流程。它提供症状、调查、解决、验证、沟通和事后复盘的参考指南,并附带一个校验脚本和一个 API 脚手架模板。产出是一份书面手册文档,包含严重级别、响应时限、确切命令和验证步骤。
适用场景
适用于记录运维流程、值班指南或事件响应过程。适合需要统一升级路径、严重级别定义以及故障或维护沟通模板的团队。
运行要求
未说明特殊运行时或凭据要求。该技能附带可执行校验脚本(scripts/validate-api.sh)和一个 YAML 脚手架模板,运行脚本需要 shell 环境。

Runbook Creation

Table of Contents

Overview

Create comprehensive operational runbooks that provide step-by-step procedures for common operational tasks, incident response, and system maintenance.

When to Use

  • Incident response procedures
  • Standard operating procedures (SOPs)
  • On-call playbooks
  • System maintenance guides
  • Disaster recovery procedures
  • Deployment runbooks
  • Escalation procedures
  • Service restoration guides

Quick Start

Minimal working example:

markdown
# Incident Response Runbook
## Quick Reference
**Severity Levels:**
- P0 (Critical): Complete outage, data loss, security breach- P1 (High): Major feature down, significant user impact- P2 (Medium): Minor feature degradation, limited user impact- P3 (Low): Cosmetic issues, minimal user impact
**Response Times:**
- P0: Immediate (24/7)- P1: 15 minutes (business hours), 1 hour (after hours)- P2: 4 hours (business hours)- P3: Next business day
**Escalation Contacts:**
- On-call Engineer: PagerDuty rotation- Engineering Manager: +1-555-0100- VP Engineering: +1-555-0101- CTO: +1-555-0102
// ... (see reference guides for full implementation)```
## Reference Guides
Detailed implementations in the `references/` directory:
| Guide | Contents ||---|---|| [Symptoms](references/symptoms.md) | Symptoms, Severity: P0 (Critical), Initial Response (5 minutes) || [Investigation Steps](references/investigation-steps.md) | Investigation Steps || [Resolution Steps](references/resolution-steps.md) | Resolution Steps || [Verification](references/verification.md) | Verification || [Communication](references/communication.md) | Communication || [Post-Incident](references/post-incident.md) | Post-Incident |
## Best Practices
### ✅ DO
- Include quick reference section at top- Provide exact commands to run- Document expected outputs- Include verification steps- Add communication templates- Define severity levels clearly- Document escalation paths- Include useful links and contacts- Keep runbooks up-to-date- Test runbooks regularly- Include screenshots/diagrams- Document common gotchas
### ❌ DON'T
- Use vague instructions- Skip verification steps- Forget to document prerequisites- Assume knowledge of tools- Skip communication guidelines- Forget to update after incidents

来源与署名

来源:aj-geddes/useful-ai-prompts位于skills/runbook-creation提交3f5182c

许可证: 无许可证

内容归原作者所有。SourceWeft 从公开仓库中收录这些内容。

举报或申请下架