こんにちは。マニュアル作成・ナレッジ共有ツール「NotePM」ブログ編集局です。
システム本番作業書のテンプレートと例文をご紹介します。
マニュアル作成・ナレッジ共有ツール「NotePM」を無料でお試し！
本番作業書とは？
本番環境のサーバーで作業を行う場合、万一の操作ミスがサービスの停止につながったり、ビジネス上の損害につながる可能性があります。作業は順調に終わったにも関わらず、確認をミスしたために実はうまく動いていなかったというのが後になって判明するケースもあります。
本番作業書ではそうした主にヒューマンエラーに起因する問題を防止すべく作成されるドキュメントになります。作業手順はもちろん、問題なく完了したことを確認する方法なども明記します。
本番作業書の目的
本番作業書が作成される目的はヒューマンエラーの防止にあります。現在、多くのシステム開発プロセスは自動化される傾向にあります。日常的なデプロイ作業はその最たるものでしょう。しかし、それ以外の本番サーバーに触れる作業は緊急、または一時的に発生するものが多数あり、自動化しづらいものです。
そこで定型化できたり、作業完了時の確認リストについて本番作業書にて定義し、ミス防止を防ぐのが目的になります。初級者はもちろんのこと、熟練者にとってもつい忘れがちな確認作業のタスクについて、漏れなく確認できるようになるでしょう。
本番作業書の書き方
本番作業書は作業全体に関するヘッダー情報、タスクを並べた作業内容、そして完了時に確認を行うための作業確認リストに分かれます。
ヘッダー情報
ヘッダー情報は作業全般に関する情報が記載されます。
作業名
行う作業ごとに分かりやすい名称を付けます。本番作業書が複数ある場合は、検索などで見つけられるのを期待する名称にするのが良いでしょう。
目的
作業目的を明記します。同じサーバーであっても目的に合わせて本番作業書を分けた方が良いでしょう。
対象システム/機器
作業対象システムや機器を明記します。複数にまたがると作業がより煩雑化しやすいので、作業の分かりやすい記述が求められるでしょう。
作業内容
実際の作業内容を明記します。なるべく簡潔に一覧表などを使うのが良いでしょう。
利用ユーザー
管理者やユーザーの権限によって作業可否がありますので、作業を行うユーザーは特定しておくべきです。これによって作業を行える担当者も特定されるでしょう。
作業システム/機器
作業を行う対象のシステムや機器を明記します。複数行う場合でも1つにまとめず、複数行に分けるべきです。
手順
実際の手順を明記します。一連の作業になる場合はリストなどを使って記述しましょう。不要な作業は書かず、必要十分な手順のみ明記します。
期待する結果
作業が問題なく完了したことを確認する方法を明記します。フォルダの作成や生成されたファイルに関する情報を記述します。これによってステップを踏みながら作業を行えるようになります。
作業確認リスト
作業が終わったら、作業確認リストに基づいてサーバーやサービスの状態を確認します。動作確認を行って、問題がないことを確認したら作業完了になります。
利用ユーザー
作業確認時においてもユーザー権限が関わることが多いので、明記しておきます。管理者の場合だけうまくいっても、システムが利用するユーザーには権限がなくてエラーになることは良くあります。
確認事項
確認すべき事項を掲載します。特定のコマンドをたたく、デーモンの起動状態を確認する、Webブラウザで特定のURLへアクセスするなどが想定されます。
期待する結果
確認事項に書かれた内容を実行した結果、得られるであろう結果を記載します。場合によってはファイルがないことが正しい動作というケースもあります。
マニュアル作成・ナレッジ共有ツール「NotePM」を無料でお試し！
システム本番作業書のサンプル例
##目的
本番サーバー下でのデータベースアップデート手順を記載します。データベースはサービスの根幹であるため、注意が必要です。作業は必ず2人で行ってください。
##対象システム/機器
データベースサーバー/アプリケーションサーバー
##作業内容
| 利用ユーザー | 作業システム/機器 | 手順 | 期待する結果 |
|---|---|---|---|
| root | アプリケーションサーバー | メンテナンスフラグを立てる 一度アプリケーションをリスタートする |
Webブラウザでサービスサイトにアクセスし、メンテナンス中になっている |
| dbadmin | データベースサーバー | データベースへの接続がすべて切れているのを確認するshow status like 'Threads_connected'; |
現在ログインしているアカウントだけである |
##作業確認リスト
| 利用ユーザー | 確認事項 | 期待する結果 |
|---|---|---|
| Webブラウザでサービスサイトへアクセスし、ログインできるのを確認 | 問題なくログインできる | |
| dbadmin | データベースのプロセスが立ち上がっているのを確認 | mysqlのプロセスが10個あるのを確認 |
NotePM（ノートピーエム） は、Webで簡単にマニュアル作成できて、強力な検索機能でほしい情報をすぐに見つけられるサービスです。さまざまな業界業種に導入されている人気サービスで、大手IT製品レビューサイトでは、とくに『使いやすいさ・導入しやすさ』を高く評価されています。
NotePMの特徴
- マニュアル作成、バージョン管理、社外メンバー共有
- 強力な検索機能。PDFやExcelの中身も全文検索
- 社内FAQ・質問箱・社内ポータルとしても活用できる
- 銀行、大学も導入している高度なセキュリティ。安全に情報共有できる
URL: https://notepm.jp/
