runbook-generator

Runbook Generator

システムのコードベース、インフラストラクチャ設定、デプロイスクリプトから、包括的な運用用 runbook.md を生成します。午前3時にインシデント対応、デプロイ、日常運用を行うオンコールエンジニア向けの内容です。

Contents

• references/discovery-patterns.md -- 調査時に確認する Glob/Grep パターンと設定ファイル。
• references/output-template.md -- 記入する runbook.md の全9セクションの構成。
• references/writing-style.md -- 明瞭さ、緊急度、網羅性、書式、正確性に関するルールと出力要件。

Workflow

1. システムを調査します。references/discovery-patterns.md の Glob パターン（Step 1）を実行し、スタックとインフラストラクチャを特定します。
2. 主要な設定を読みます。references/discovery-patterns.md に記載された設定ファイル（Step 2）を開いて分析します。対象は IaC、コンテナー、CI/CD、アプリ設定、デプロイスクリプト、監視、マイグレーション、ロードバランサー、ドキュメントです。
3. 運用時の挙動を特定します。references/discovery-patterns.md の Grep パターン（Step 3）を実行し、ヘルスチェック、メトリクス、キャッシュ、ジョブ、マイグレーション、ロールバック、スケーリング、バックアップ、TLS、シークレット、アラートなどを調べます。
4. Runbook を生成します。references/output-template.md の構成に従って runbook.md を作成します。全9セクションを網羅し、調査で判明した内容に合わせて調整し、推測だけに基づくセクションは含めないでください。
5. 執筆基準を適用します。references/writing-style.md のすべてのルールに従います。コピーして実行できるコマンド、期待される出力、順序立てた手順、P1を優先した順序、構造化データ向けの表、正確性に関するルールを含めます。
6. 検証し、不足項目に印を付けます。参照されているパスとスクリプトが存在することを確認します。検証できない詳細には [VERIFY]、不足しているセクションには [ACTION REQUIRED]: ... を付け、Runbook をギャップ分析にも使えるようにします。

Output

runbook.md をプロジェクトのルート（またはユーザーが指定するディレクトリ）に書き込みます。500行以上で、全9セクションを網羅し、コードベースに由来する実際のコマンドを含め、少なくとも1つのアーキテクチャ図と完全な目次を備え、インフラストラクチャの詳細を決して捏造しないでください。出力チェックリストの全容については references/writing-style.md を参照してください。