リリース作業の前に「手順書」を開き、上から順に一つずつ確認しながら落ち着いて本番反映を進めている一人運用の保守担当者

リリース手順書の作り方|一人でも迷わない最低限の項目テンプレート

金曜の夜、リリース作業。 サーバーにログインして、ファイルを差し替えて、キャッシュを消して……あれ、この後キャッシュだったっけ、それとも先にDBの反映だったっけ。

手が止まる。前回もやったはずなのに、細かい順番が思い出せない。 思い出しながら進めて、ひとつ飛ばして、あとから「あ、あれやってなかった」と冷や汗をかく。

リリースが怖いのは、手順が難しいからではありません。 手順が自分の頭の中にしかなくて、焦ると飛ぶからです。

この「頭の中の段取り」を、外に書き出して、読むだけで動ける形にしたものがリリース手順書(runbook)です。 立派なマニュアルはいりません。この記事では、一人運用でも続く軽い作り方と、最低限これだけ埋めれば回るという項目テンプレートを、一緒に整理していきます。一度に完璧なものを作らなくて大丈夫です。

結論:リリース手順書は「きれいな文書」ではなく、「焦っている夜の自分が、上から順に読むだけで作業を終えられるメモ」です。やることは4つ。①前回のリリースを1回、やった手順のまま書き起こす②「作業前」「作業」「確認」「戻し方」の4ブロックに分ける③コマンドやURLはコピペできる形でそのまま貼る④リリースのたびに1行ずつ直して育てる。まずは次の1回を、手順どおりに書き取るところから始めます。
リリースの形(手動デプロイ・CI/CD・コンテナ・レンタルサーバーのファイル差し替えなど)によって、手順の中身は変わります。この記事は「どんなリリースにも共通して必要な項目」を整理したものです。自分の環境に読み替えて、本番反映の前には検証環境や公式情報で確認してください。

なぜ「手順書がない」まま回してしまうのか

手順書を作れていないのは、意識が低いからでも、面倒くさがりだからでもありません。一人運用の現場ほど、作れない事情が重なっています。

どれも自然なことです。でも、手順が頭の中だけにあると、疲れている夜・急いでいる朝・割り込みが入った最中——いちばん飛ばしたくない場面で、するっと工程が抜けます。しかも一人だと、抜けたことに気づいてくれる人もいません。

だからこそ、手順書は「立派に作る」のではなく「まず今の自分のやり方を、そのまま書き取る」ところから始めるのが続くコツです。ゼロから設計しなくていい、という前提を持つと、ぐっと気が楽になります。

リリース手順書は「4つのブロック」でできている

リリース手順書は「作業前の準備」「作業本体」「作業後の確認」「戻し方」の4つのブロックに分けて書くと迷わないことを示した図
手順書は4ブロックで考える。この順に並べるだけで、抜けが見えてくる

手順書というと項目が多くて構えてしまいますが、中身は大きく4つのブロックに分けられます。この順に並べるだけで、「何が抜けているか」が見えてきます。

多くの人は②の作業だけを手順書だと思いがちですが、事故を防ぐのは①と③、心を守るのは④です。作業本体だけでなく、その前後と逃げ道までを1枚にまとめておくのが、リリース手順書の役割です。

最低限これだけ埋める:項目テンプレート

リリース手順書に最低限書いておく項目を、作業前・作業・確認・戻し方のブロックごとに並べたテンプレートの図
最初は空欄でいい。次のリリースで、埋められるところから埋めていく

先ほどの4ブロックに沿って、実際に書く項目をテンプレートにしました。全部を最初から埋める必要はありません。空欄のまま置いておいて、次のリリースで「あ、これが要る」と気づいたところから足していけば十分です。

手順書の冒頭(このリリースは何か)

まず、この手順書が何のリリースかを1〜2行で。あとから見返したときに、すぐ思い出せます。

① 作業前(準備)

② 作業(本体・番号を振る)

ここは番号付きで、上から順にやれば終わるように書きます。コマンドは実際に打つ形で貼ります。

  1. (例)本番サーバーに接続する:ssh ...
  2. (例)現在のファイルを退避する:cp -r ...(旧版を別名で残す=戻せるように)
  3. (例)新しいファイルを配置する:...
  4. (例)DBの反映を行う:...(戻し用SQLは④に用意)
  5. (例)キャッシュをクリアする:...
  6. (例)サービスを再起動する:...
ポイントは、「頭で分かっている当たり前の一手」ほど省かずに書くこと。「キャッシュ削除」「再起動」「権限の設定」など、飛ばすと事故になるのに記憶から抜けやすい工程こそ、番号にして固定します。

③ 確認(作業後)

④ 戻し方(うまくいかないとき)

「戻す手順」を用意しておくと、リリースのボタンを押すときの怖さがまるで変わります。戻し方そのものの詳しい考え方は、別記事(記事末尾の関連リンク)で深掘りしています。

具体例:手順書がある夜と、ない夜

同じトラブルでも、手順書があるかないかで、その夜の重さがまるで違います。

差を生んだのは、技術力でも度胸でもありません。やることを事前に、外に書き出してあったかどうかだけです。

影響:手順書を1枚持つと、何が変わるか

リリース手順書が1枚あるだけで、日々の運用がいくつも軽くなります。

逆に、手順が頭の中だけのままだと、リリースは毎回ゼロから神経を使う作業になり続けます。1枚書いておくことは、未来の自分の負担を、少しずつ減らしていく投資です。

明日やること:次のリリースを「書きながら」やってみる

手順書を机に向かってゼロから書こうとすると、たいてい続きません。おすすめは、次のリリースを、手を動かしながらそのまま書き取るやり方です。

  1. メモを1枚(テキストファイルでもよい)用意し、冒頭に「対象・内容・日時」を書く。
  2. リリース作業をしながら、やった操作を上から順にメモしていく。コマンドはコピペで貼る。
  3. 途中で確認した画面・叩いた機能を、③の「確認」として書き足す。
  4. 退避したファイルや、戻すとしたらどうするかを、④の「戻し方」に1〜2行で書く。
  5. 終わったら、①の「作業前」に、今回やっておくべきだったこと(バックアップ・告知など)を追記する。

これで、次回そのまま使える手順書の初版が1枚できます。次のリリースでは、それを開いて上から実行し、違ったところ・抜けていたところを1行ずつ直す。この「使いながら育てる」を数回繰り返すだけで、手順書は自分の環境にぴったり合った、頼れる1枚になっていきます。

リリース手順書チェックリスト

手順書を作るとき・見直すときに、抜けがないかを確かめる項目です。コピーして使ってください。全部を一度にそろえる前提ではありません。まずは「これだけは」の3つから。

これだけは(最低ライン)

余裕があるとき(任意)

全部に○が付かなくても大丈夫です。上の3つがあれば、記憶頼りのリリースからは抜け出せます。下の項目は、リリースを重ねながら少しずつ足していけば十分です。

よければ、こちらも

リリース手順書は、戻し方・チェックリスト・変更の記録と地続きの仕事です。あわせて整えておくと、リリースの夜がぐっと落ち着きます。

リリース手順書を1枚持てて、次のリリースを落ち着いた気持ちで迎えられるようになった保守運用の担当者

リリースが毎回しんどいのは、あなたの段取りが悪いからではありません。段取りを、毎回その場で組み直しているからです。一度書き出して、次から読むだけにする。それだけで、負担はずいぶん軽くなります。 今日は、次のリリースを「書きながらやってみる」だけで十分です。その1枚が、未来のあなたの夜を、少しずつ静かにしてくれます。

ほかの実務ヒントは記事一覧からどうぞ。保守運用の小さな備えを、メールでも少しずつお届けしています。

関連用語