runbook-generator

ランブック生成ツール

コードベースを分析し、コピーして実行できるコマンド、各手順後の検証チェック、すべての破壊的な操作に対するロールバック手順、連絡先情報を含むエスカレーション経路、キャパシティプランニング用の所要時間を備えた、本番環境向けの運用ランブックを生成します。スタック（CI/CD、データベース、ホスティング、コンテナ）を検出し、実際のインフラに合わせたランブックを作成します。参照先の設定ファイルが変更された場合にランブックへフラグを付ける、陳腐化検出機能も備えています。

キーワード： ランブック、運用手順、インシデント対応、デプロイ、ロールバック、データベースメンテナンス、スケーリング、モニタリング、オンコール、SRE、ポストモーテム

主な機能

• スタック検出 — リポジトリ内のファイルから CI/CD プラットフォーム、データベース、ホスティング、オーケストレーションを特定し、ランブックテンプレートに対応付けます。接続文字列、デプロイコマンド、インフラの詳細を抽出します。
• ランブックの種類 — デプロイ（事前チェック、デプロイ、スモークテスト、ロールバック）、インシデント対応（トリアージ→診断→緩和→解決→ポストモーテム）、データベースメンテナンス（バックアップ、マイグレーション、バキューム、再インデックス）、スケーリング（水平／垂直）、モニタリング（アラート、ダッシュボード、オンコールローテーション）。
• 形式の徹底 — コピーして実行できるコマンド付きの番号付き手順、各手順の後に必ず VERIFY チェック、所要時間、すべての破壊的な操作に対するロールバック手順、判断基準を含むエスカレーション経路。
• メンテナンス — 設定ファイルの更新日時と連動した陳腐化検出、四半期ごとのレビューサイクル、ステージング環境でのドライラン検証フレームワーク。

使用する場面

• コードベースにランブックがなく、初期作成が必要な場合。
• 既存のランブックが古い、または不完全な場合。
• オンコールローテーションに参加する新しいエンジニアをオンボーディングする場合。
• インシデント対応訓練の準備をする場合。
• インシデント発生後の改善として、学んだ教訓をランブックに反映する場合。

まず確認すること

ランブックを生成する前に、次の情報を確認してください。不明または曖昧な項目があれば、推測せずに質問してください。

• ランブックの種類 — デプロイ／インシデント対応／データベースメンテナンス／スケーリング／モニタリング（テンプレートと手順構成を決定します）
• 実際のスタック — CI/CD プラットフォーム、データベース、ホスティング、オーケストレーション（コピーして実行できるすべてのコマンドとロールバック手順は、スタックによって異なります）
• エスカレーション先と重大度別の振り分け — 各レベルで誰にページを送るか（エスカレーション表を作成します。これがないランブックはオンコールで使用できません）

停止ルール：出力を大きく左右する項目を2～3個だけ質問してください。ユーザーが「とにかく草案を作って」と言った場合は作成を進め、成果物の冒頭に前提を列挙してください。

ツール

ツール	用途	コマンド
runbook_scaffolder.py	JSON サービス定義からランブックの Markdown テンプレートを生成します	python scripts/runbook_scaffolder.py -i service.json --type deployment -o runbook.md
runbook_validator.py	ランブックの Markdown を完全性と品質の観点から検証します（必須セクション、VERIFY ブロック、ハードコードされた認証情報、エスカレーション表）	python scripts/runbook_validator.py --dir docs/runbooks --strict
staleness_checker.py	設定可能な陳腐化しきい値に照らして、ランブックの鮮度をチェックします	python scripts/staleness_checker.py docs/runbooks --threshold 90 --json

参考資料

タスクに合った参考資料を読み込みます。このファイルは簡潔に保ち、必要に応じて詳細を確認してください。

• references/runbook-templates.md — スタック検出用のシェルコマンドと、コピーして使えるコマンド、VERIFY ブロック、ロールバック、エスカレーション表を含む、デプロイ、インシデント対応、データベース保守の完全なランブックテンプレートです。リポジトリを調査するときやランブックを作成するときに読みます。
• references/staleness-and-maintenance.md — 古さを検出する CI スクリプトと、7 ステップの四半期レビュー手順です。鮮度チェックを自動化するときや、四半期レビューを実施するときに読みます。
• references/quality-and-troubleshooting.md — よくある落とし穴、ベストプラクティスのチェックリスト、トラブルシューティング表、成功基準です。ランブックを公開する前に読みます。

対象範囲と制限事項

このスキルの対象：

• コードベースの分析に基づく、デプロイ、インシデント対応、データベース保守、スケーリング、監視のランブック生成
• 一般的な CI/CD プラットフォーム（GitHub Actions、GitLab CI、Jenkins）、データベース（PostgreSQL、MySQL、MongoDB）、ホスティングプロバイダー（Vercel、Fly.io、Kubernetes、AWS）のスタック検出
• 古さの検出の自動化と四半期レビューのプロセス
• 重大度に応じた振り分けを含むエスカレーション経路のテンプレート

このスキルの対象外：

• ランブックの手順の自動実行 — 生成するのはドキュメントであり、オーケストレーションではありません（自動化されたパイプラインについては ci-cd-pipeline-builder を参照）
• インフラストラクチャのプロビジョニングや Terraform/Pulumi コードの生成（スキーマ移行ツールについては migration-architect を参照）
• Prometheus ルール、Grafana ダッシュボード、アラート定義などのオブザーバビリティスタックのセットアップ（監視インフラストラクチャについては observability-designer を参照）
• セキュリティインシデント対応や脆弱性の修正に関するプレイブック（セキュリティに特化した分析については skill-security-auditor を参照）

統合ポイント

スキル	統合	データフロー
ci-cd-pipeline-builder	ランブックのデプロイ手順をパイプラインの各段階に合わせます	パイプラインの設定がデプロイランブックの生成に反映され、ランブックのロールバック手順はパイプラインのロールバックトリガーを参照します
observability-designer	監視ランブックがアラートルールとダッシュボードを参照します	オブザーバビリティの出力（アラート名、ダッシュボード URL）が、ランブックの VERIFY 手順と監視手順に組み込まれます
migration-architect	データベース保守ランブックが移行ツールの規約を使用します	移行ファイルのパスとコマンドがデータベースランブックのテンプレートに反映され、ロールバック手順は移行のロールバックコマンドと一致します
release-manager	リリースプロセスがランブック実行のチェックポイントを起動します	リリースタグと変更履歴がランブックの古さチェックに反映され、リリースゲートがランブックのデプロイ前チェックリストを参照します
env-secrets-manager	ランブックのコマンドがシークレット管理ツールで管理される環境変数を参照します	シークレット名とボールトのパスがランブックの環境変数参照に反映され、ローテーションのスケジュールがランブックの更新頻度に反映されます
changelog-generator	デプロイ後のランブック手順が変更履歴のエントリーを相互参照します	変更履歴の差分により、リリース後に再検証が必要なランブックの手順を特定できます