runbook

/runbook

見慣れないプレースホルダーがある場合や、接続されているツールを確認する必要がある場合は、CONNECTORS.md を参照してください。

繰り返し行うタスクや手順について、ステップごとの運用ランブックを作成します。

使用方法

/runbook $ARGUMENTS

出力

## Runbook: [Task Name]
**Owner:** [Team/Person] | **Frequency:** [Daily/Weekly/Monthly/As Needed]
**Last Updated:** [Date] | **Last Run:** [Date]

### Purpose
[What this runbook accomplishes and when to use it]

### Prerequisites
- [ ] [Access or permission needed]
- [ ] [Tool or system required]
- [ ] [Data or input needed]

### Procedure

#### Step 1: [Name]

[正確なコマンド、アクション、または手順]

**Expected result:** [What should happen]
**If it fails:** [What to do]

#### Step 2: [Name]

[正確なコマンド、アクション、または手順]

**Expected result:** [What should happen]
**If it fails:** [What to do]

### Verification
- [ ] [How to confirm the task completed successfully]
- [ ] [What to check]

### Troubleshooting
| Symptom | Likely Cause | Fix |
|---------|-------------|-----|
| [What you see] | [Why] | [What to do] |

### Rollback
[How to undo this if something goes wrong]

### Escalation
| Situation | Contact | Method |
|-----------|---------|--------|
| [When to escalate] | [Who] | [How to reach them] |

### History
| Date | Run By | Notes |
|------|--------|-------|
| [Date] | [Person] | [Any issues or observations] |

コネクターが利用可能な場合

~~knowledge base が接続されている場合：

• ゼロから作成するのではなく、既存のランブックを検索して更新します
• 完成したランブックを運用 wiki に公開します

~~ITSM が接続されている場合：

• ランブックを関連するインシデントの種類や変更リクエストにリンクします
• オンコールスケジュールからエスカレーション先の連絡先を自動入力します

ヒント

1. 具体的に記述します — 「スクリプトを実行する」は手順とは言えません。「運用サーバーから python sync.py --prod --dry-run を実行する」のように記述します。
2. 障害パターンを含めます — 各ステップで起こりうる問題と、その対処方法を記載します。
3. ランブックをテストします — 手順に慣れていない人に実際に従ってもらいます。つまずいた箇所を修正します。