mcpField
R
runbook-creation

runbook-creation

github.com/aj-geddes云与 DevOps373454 次安装34 周前更新
代码仓库

关于 runbook-creation

用于编写运维手册的技能，涵盖事件响应、日常操作、维护和恢复的分步流程，适合整理值班与服务运维程序。

主要功能

  1. 01事件响应流程
  2. 02SOP 与值班手册
  3. 03维护与恢复指南
  4. 04严重级别与升级指引
  5. 05验证与沟通步骤

适用场景

  1. 01编写事件响应流程
  2. 02准备值班操作手册
  3. 03记录部署或维护步骤
  4. 04规划服务恢复程序

安装

复制下面的命令，在终端中运行。

$npx skills add https://github.com/aj-geddes/useful-ai-prompts --skill runbook-creation

安装后在 Claude Code 中输入/runbook-creation确认已加载。

包含的文件

除 SKILL.md 外，安装时一起下载的参考资料和脚本。

references/
communication.md
investigation-steps.md
post-incident.md
resolution-steps.md
symptoms.md
verification.md
scripts/
validate-api.sh
templates/
api-scaffold.yaml

详细介绍

操作手册编写

目录

概述

编写全面的操作手册，为常见的运维任务、事件响应和系统维护提供分步操作流程。

适用场景

  • 事件响应流程
  • 标准操作规程（SOP）
  • 值班手册
  • 系统维护指南
  • 灾难恢复流程
  • 部署操作手册
  • 升级处理流程
  • 服务恢复指南

快速开始

最小可用示例：

# 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

评论

支持 Markdown