← 一覧へ
✍️ 文章・資料を書くCC / Codex 両対応難易度: 中級

エンジニアリング・ランブック eng-runbook

サービス運営の必須情報を一目でチェック

出典リポの★
94,103
最終更新
28日前
作者
nexu-io

これは何?

エンジニアリング・ランブックは、サービスを円滑に運営するために必要な情報を1ページにまとめたドキュメントです。アラート対応の手順やダッシュボードへのリンク、よく使うコマンドなどをわかりやすく整理します。普段の運用からトラブル対応まで、必要な情報がすぐに見つかるので、安心してサービス運営ができます。

エンジニアリング・ランブックの紹介マンガ

これでできること

  • サービスの概要と依存関係を簡単に説明できる
  • 発生しやすいアラートとその対応方法を一覧表示できる
  • よく使う操作手順とコマンドをすぐに確認できる
  • インシデント発生時の対応手順をステップで確認できる

こんな時に便利

新しいチームメンバーにサービスについて説明する
インシデント時に確認すべき項目を洗い出す
定期点検やメンテナンス作業の手順を確認する
オンコール担当者がトラブルに対処する際に参照する

使い方

まずサービスの概要をDESIGN.mdで確認し、対象のサービスを特定します。サービス名、チーム、重要度などをヘッダーに記入し、内容を整理していきます。アラート表やリンクリスト、手順ブロックなどを順番に作成し、最後にHTMLで整えます。

使用例(こう頼んでみよう)

SREチーム向けのランブックを作成してくださいこのサービスの運用手順をランブック形式でまとめてくださいオンコールガイドとインシデント対応手順を含むランブックを生成してください

必要なもの

  • 特になし

導入方法

いちばん簡単(AIに頼む)
次のスキルを入れて: https://github.com/nexu-io/open-design/tree/main/design-templates/eng-runbook
手動で置く
Claude Code → ~/.claude/skills/eng-runbook/
Codex → ~/.agents/skills/eng-runbook/

使いこなしのコツ

  • よく使うコマンドはコピペしやすいようにコードブロックで囲むと良い
  • 重要度の高いアラートから順に並べるとわかりやすい