絶対に失敗しないリリース手順書の書き方
こんにちは、システムエンジニアのようへいです。
エンジニアの方であれば、システムのリリース作業は何度も立ち会っていることと思います。
若い頃はリリース手順書を作らずリリースしていて、大慌てしたことがありました。
それからはリリース手順を確実に作るようにしています。
今日は、開発したシステムのリリース時に必要になるリリース手順書の書き方をまとめます。
リリース手順書とは
開発したシステムを顧客の運用環境に導入する際に必要な手順を記載したドキュメントです。
業界的にはWordやExcelで作られることが多いですが、表形式で構成した方が使い勝手が良いので、個人的にはいつもExcelで作っています。
リリース手順書を作る目的
名前的に「リリース作業そのものを行うための手順書」と思われがちですが、それだけではありません。
リリース準備、各手順の作業時間の計画やフォールバック（切り戻し）のチェックポイント・判断基準の明確化、リリース後の確認手順といった、リリース準備～リリース後の確認まで、どのような事態になっても混乱なく行うための手順です。
具体的には以下が目的と考えています。
リリース作業を効率的かつ安全に進めるための手順を文書化すること
リリース担当者間で作業漏れや誤操作を防ぐために手順を統一すること
トラブル時の原因特定や障害復旧を迅速に行うための情報を事前に整理しておくこと
リリース後の稼働状況確認方法や異常検知ルールを定めておくこと
リリース作業のステータスや結果を一元的に報告できるようにしておくこと
リリース手順書の作り方
リリース作業者全員が、リリース手順や目的を正しく理解できる内容にする必要があります。
以下は自分が良く使っている構成です。
手順書の章立て
リリース作業に必要な情報を全て明文化しています。
事前に作成し、リリース作業者と顧客ですり合わせすることが大事です。
１．はじめに
１－１．リリース目的
１－２．対象システム
１－３．前提条件
２．作業手順
●局面ごとに明示的にブロックを分け、手順を書きます。
２－１．リリース前の準備手順
２－２．リリース作業手順
２－３．リリース後の稼働準備手順
２－４．リリース後の稼働後確認手順
３．リリース体制
●氏名、連絡先、連絡可能時間帯を整理
３－１．リリース作業側体制
３－２．顧客側体制
４．異常時対応手順
４－１．エラー状況に応じた原因特定と対処手順
４－２．リリース中止判断基準
４－３．切り戻し手順
５．リリース報告
●どういう手段で誰にどんな項目を報告するか
５－１．報告手段
５－２．報告内容
作業手順に書くべき項目
一番重要なのが「２．作業手順」です。
ここを1つでも間違うと、リリース作業が全て台無しになります。
以下の項目を一覧形式で挙げておくと良いでしょう。
作業手順名 - 「何をする」を端的に表現。
作業内容 - 操作1つ1つを正しく記述。必要ならコマンドも記載。
前提条件 - その作業の前提条件があれば記載。
作業目的 - なぜその作業が必要なのかを記載。
担当者 - 誰が行うのかを明確に。
作業環境 - どこのサーバ、フォルダで作業するか。
想定作業時間 - その作業の見積もり時間。
開始予定日時 - その作業の開始予定日時。
終了予定日時 - その作業の終了予定日時（開始予定日時＋想定作業時間）
実績作業時間 - その作業の実績時間。
開始日時 - その作業の開始実績日時。
終了日時 - その作業の終了実績日時。
異常時対応手順 - 異常時の対応内容を記載。参照先があるならそれを記載
この項目構成のポイントは、
この手順書が今後も繰り返し使われる場合、手順の改版の可能性を考慮して、作業目的を明確化していること。
目的が分かれば、手順の改廃の必要性が判断できます。予定時刻と実績時刻を管理することで、現在時点で予定時刻からどれだけ遅れ／進んでいるかわかり、今後の見通しが立てやすくなります。
異常時対応手順を明確にすることで、タイムロスなく異常時の対応に入れます。
手順進行の待ち合わせとして、どうなれば手順が進むかは前提条件に整理します。
リリース手順書は必ずレビューする
セルフレビューは2回行う
日を置いて最低2回は必ずセルフレビューすることをオススメします。
Day1：作成完了後にセルフレビュー
Day2：クリアな頭でセルフレビュー
手順書を作った直後だけあって、初回のセルフレビューは割とザルなんですよ。
手順が抜けていても、頭の中で勝手に補完されてしまいますからね。
翌日にクリアな頭でもう一度レビューすると、欠陥にしっかり気づけます。
リリース作業者と顧客でレビュー
リリース手順書の読み合わせを必ず関係者全体で行いましょう。
お互いの手順の確認と、コミュニケーションパスをしっかりと握っておくことで、作業者間の作業のバトンタッチはスムーズに行えます。
この記事が気に入ったらサポートをしてみませんか？