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 從公開儲存庫中收錄這些內容。

檢舉或申請下架