eng-runbook について
eng-runbookは、サービスの概要とDESIGN.mdをもとに、1ページのエンジニアリング運用手順書を作成するスキルです。アラート、手順、オンコール体制、インシデント対応をHTMLでまとめます。
主な機能
- 01DESIGN.mdの確認とサービス特定
- 02サービス概要と依存関係一覧
- 03重大度と初動対応を含むアラート
- 04手順とオンコール体制
- 055段階のインシデントチェックリスト
- 06HTML出力形式
活用シーン
- 01オンコール担当者向けのサービス文書作成
- 02アラートの意味と初動対応の記録
- 03デプロイ、ロールバック、キー更新手順の提示
インストール
コマンドをコピーしてターミナルで実行します。
$
npx skills add https:/ / github.com/ nexu-io/ open-design --skill eng-runbookインストール後、Claude Code で/eng-runbookを入力して読み込まれたか確認します。
同梱ファイルexample.html
詳細
エンジニアリング運用手順書スキル
1 ページのエンジニアリング運用手順書を作成します。
ワークフロー
- DESIGN.md を読みます。
- 概要説明からサービスを特定します。
- レイアウト:
- ヘッダー:サービス名、担当チーム、重大度ティア、バージョン。
- サービス概要の段落 + 依存関係のリスト。
- アラートの表:アラート名 / 重大度 / 意味 / 初動対応。
- ダッシュボードとリンクのリスト。
- 一般的な手順のブロック(3〜4 件)。コードブロックを含めます(デプロイ、ロールバック、キーのローテーション)。
- オンコールローテーションの表(週 / 主担当 / 副担当 / バックアップ)。
- インシデント対応チェックリスト(番号付きの 5 ステップ)。
- インラインの
<style>を 1 つ使用し、セマンティック HTML を使い、コードブロックには等幅フォントを指定します。
出力仕様
<artifact identifier="runbook-name" type="text/html" title="Service Runbook">
<!doctype html>...</artifact>
コメント
Markdown 対応