システム手順書の書き方｜コピペできるテンプレートとチェック項目30

システムの手順書とは、作業する人が変わっても同じ操作で同じ結果になるように、操作と確かめ方を1行ずつ書いた文書です。 わかりやすさを決めるのは文章のうまさではなく、「1行に1操作」と「期待結果を見える値で書く」の2点です。

この記事では、表紙から作業記録欄までのテンプレートを本文にそのまま載せ、架空の備品予約システムの Web サーバー設定変更を題材に、Linux のコマンドと実際の出力を埋めた記入例を示します。リリース作業に固有の判定表や、運用全体の設計項目には立ち入らず、どの作業にも使える書式と書き方に絞ります。

確認環境：Ubuntu 24.04.4 LTS、nginx 1.24.0、curl 8.5.0、bash 5.2.21、GNU sed 4.9、GNU diffutils 3.10（確認日 2026-10-05）。記入例のコマンドはすべてこの環境で実行し、出力をそのまま載せています。ホスト名とパスは yoyaku-web01、/home/taro/yoyaku-web に置き換えています。

この記事の結論

• 1行に1操作。実行コマンド・期待結果・確認コマンド・NG時の対応を横に並べた表にする。
• 期待結果は「表示される文字列か数値」で書く。出力が出ないのが正しいときは「出力なし」と書く。
• 構成は 表紙 → 事前確認 → 手順本体 → 事後確認 → 切り戻し → 作業記録 の6パート。
• 切り戻しにも期待結果を書き、検証用の環境で一度通して実行してから使う。
• 1回きりの変更は作業手順書、繰り返す作業は運用手順書、全体の説明はマニュアルに分ける。

手順書の構成早見表

作業手順書・運用手順書・マニュアルの違いと使い分け

呼び名が似ている3つの文書は、書く対象と使う回数で分けると整理できます。

どれを書くかは、次の条件で決められます。

3つとも表の列は共通にできます。違いは表紙と記録欄で、作業手順書は「その日の日時と切り戻し」、運用手順書は「実施のきっかけと繰り返しの記録」を厚く書きます。

コピペ用テンプレート（Markdown）

かっこの中を書き換えて使います。「結果」は OK / NG、「時刻」は実行した時刻を作業中に書き込みます。

表紙

事前確認

手順本体

事後確認

切り戻し

作業記録

コピペ用テンプレート（タブ区切り）

表計算ソフトの A1 セルに貼ると、列に分かれます。事前確認と事後確認は「確認コマンド」の列を空欄のまま使います。

区分  No  操作  実行コマンド  期待結果    確認コマンド  NG時の対応  結果  時刻
事前確認    P-1 （作業対象のサーバーであること）    （コマンド）  （表示される値）        （作業を始めない、連絡先へ連絡）        
事前確認    P-2 （変更前の値） （コマンド）  （表示される値）        （作業を始めない）       
事前確認    P-3 （変更前の動作）    （コマンド）  （表示される値）        （作業を始めない）       
手順  1   （バックアップを取る） （コマンド）  （出力なし、など）   （コマンド）  （中止。変更前なので切り戻し不要）       
手順  2   （設定を変更する）   （コマンド）  （出力なし、など）   （コマンド）  （切り戻し R-1 へ）        
手順  3   （反映する）  （コマンド）  （表示される文字列）  （コマンド）  （切り戻し R-1 へ）        
事後確認    C-1 （変更後の動作）    （コマンド）  （表示される値）        （切り戻し R-1 へ）        
事後確認    C-2 （変更していない機能の動作）  （コマンド）  （表示される値）        （切り戻し R-1 へ）        
事後確認    C-3 （ログにエラーが出ていないこと）    （コマンド）  （表示される値）        （切り戻し R-1 へ）        
切り戻し    R-1 （バックアップから戻す）    （コマンド）  （出力なし、など）   （コマンド）  （判断者へ連絡）        
切り戻し    R-2 （反映する）  （コマンド）  （表示される文字列）  （コマンド）  （判断者へ連絡）        
切り戻し    R-3 （変更前の動作に戻ったこと）  （コマンド）  （表示される値）    （コマンド）  （判断者へ連絡）        

表紙と作業記録は次の2列です。

項目  内容
文書名・版   
対象  
目的  
作業日時    
作業者・確認者 
影響  
前提条件    
中止・切り戻しの基準  
連絡先 
改訂履歴    
開始時刻・終了時刻   
結果  完了 / 切り戻し / 中止
手順書と違った点    
期待結果と違った出力（貼り付け）    
次回への申し送り    
作業者・確認者の署名  

記入例：Webサーバーの設定変更手順書

題材は、架空の社内向け備品予約システムです。添付ファイルの上限を広げるため、nginx の client_max_body_size を 1m から 20m に変更します。nginx の公式ドキュメントでは、この値の既定は 1m で、超えた要求には 413（Request Entity Too Large）を返すと説明されています。

表紙

事前確認

コマンド欄 A（2MB のファイルを送り、HTTP の状態コードだけを表示する）

curl -s -o /dev/null -w '%{http_code}\n' -X POST --data-binary @/tmp/test_2mb.bin http://127.0.0.1:9890/upload

手順本体

事後確認

コマンド欄 B（25MB のファイルを送る）

curl -s -o /dev/null -w '%{http_code}\n' -X POST --data-binary @/tmp/test_25mb.bin http://127.0.0.1:9890/upload

切り戻し

記入例のタブ区切り版

区分  No  操作・確認内容 実行コマンド  期待結果    確認コマンド  NG時の対応
事前確認    P-1 対象サーバーにログインしている hostname    yoyaku-web01 と表示        ログアウトし、接続先を確かめ直す
事前確認    P-2 作業ディレクトリへ移動する   cd /home/taro/yoyaku-web    出力なし        パスを確かめる。作業は始めない
事前確認    P-3 nginx が起動している   ps -o pid,user,args -p "$(cat nginx.pid)"   nginx: master process の行が1行出る       作業を始めず、運用チームへ連絡
事前確認    P-4 変更前の値が 1m である   grep -n client_max_body_size conf.d/yoyaku.conf 4:    client_max_body_size 1m; の1行だけ        値や行数が違えば作業を始めない（手順書の前提と違う）
事前確認    P-5 テスト用の 2MB ファイルを作る   head -c 2097152 /dev/zero > /tmp/test_2mb.bin   出力なし        /tmp の空きを確かめる
事前確認    P-6 変更前は 2MB の送信が 413 になる   curl -s -o /dev/null -w '%{http_code}\n' -X POST --data-binary @/tmp/test_2mb.bin http://127.0.0.1:9890/upload  413 と表示     200 なら既に変更済みの可能性。作業を始めず確認者と相談
事前確認    P-7 ディスクに空きがある  df -h . Avail が 1G 以上       空きを作るまで作業を始めない
手順  1   設定ファイルをバックアップする cp -p conf.d/yoyaku.conf conf.d/yoyaku.conf.bak_20261005    出力なし    diff conf.d/yoyaku.conf conf.d/yoyaku.conf.bak_20261005 → 出力なし  中止する（まだ何も変えていない）
手順  2   上限値を 1m から 20m に書き換える   sed -i 's/client_max_body_size 1m;/client_max_body_size 20m;/' conf.d/yoyaku.conf   出力なし    diff conf.d/yoyaku.conf.bak_20261005 conf.d/yoyaku.conf → 4行目の1か所だけ差分が出る    差分が出ない・2か所以上出るときは R-1 へ
手順  3   設定の文法を検査する  nginx -c /home/taro/yoyaku-web/nginx.conf -t    syntax is ok と test is successful の2行   （実行コマンドの出力で確認）  [emerg] が出たら反映せず R-1 へ
手順  4   設定を再読み込みする  nginx -c /home/taro/yoyaku-web/nginx.conf -s reload signal process started の1行  事後確認 C-1 へ進む    [emerg] や [error] が出たら R-1 へ
事後確認    C-1 2MB の送信が通る  curl -s -o /dev/null -w '%{http_code}\n' -X POST --data-binary @/tmp/test_2mb.bin http://127.0.0.1:9890/upload  200 と表示     R-1 へ
事後確認    C-2 25MB のテストファイルを作る    head -c 26214400 /dev/zero > /tmp/test_25mb.bin 出力なし        /tmp の空きを確かめる
事後確認    C-3 上限を超える 25MB は止まる    curl -s -o /dev/null -w '%{http_code}\n' -X POST --data-binary @/tmp/test_25mb.bin http://127.0.0.1:9890/upload 413 と表示     200 なら上限が効いていない。R-1 へ
事後確認    C-4 トップページが表示される    curl -s http://127.0.0.1:9890/  yoyaku top と表示      R-1 へ
事後確認    C-5 エラーログに重大な記録がない  grep -c -e emerg -e alert -e crit logs/error.log    0 と表示       件数が 1 以上ならログの該当行を記録欄に貼り、R-1 へ
事後確認    C-6 nginx の親プロセスが変わっていない    ps -o pid,user,args -p "$(cat nginx.pid)"   P-3 と同じ PID の行が出る       運用チームへ連絡
事後確認    C-7 テストファイルを消す（切り戻す場合は R-4 のあと） rm /tmp/test_2mb.bin /tmp/test_25mb.bin 出力なし        ファイル名を確かめて消し直す
切り戻し    R-1 バックアップから設定を戻す   cp -p conf.d/yoyaku.conf.bak_20261005 conf.d/yoyaku.conf    出力なし    grep -n client_max_body_size conf.d/yoyaku.conf → 4:    client_max_body_size 1m;    判断者へ連絡
切り戻し    R-2 設定の文法を検査する  nginx -c /home/taro/yoyaku-web/nginx.conf -t    syntax is ok と test is successful の2行   （実行コマンドの出力で確認）  反映せず判断者へ連絡
切り戻し    R-3 設定を再読み込みする  nginx -c /home/taro/yoyaku-web/nginx.conf -s reload signal process started の1行  R-4 へ進む 判断者へ連絡
切り戻し    R-4 変更前の動作に戻ったことを確かめる   curl -s -o /dev/null -w '%{http_code}\n' -X POST --data-binary @/tmp/test_2mb.bin http://127.0.0.1:9890/upload  413 と表示 （実行コマンドの出力で確認）  判断者へ連絡

記入例を実際に実行したログ

上の手順書を上から順に実行した出力です。[終了コード n] は直前のコマンドの終了コードを表示するために付けた行です。

事前確認のログ

$ hostname
yoyaku-web01
[終了コード 0]
$ ps -o pid,user,args -p "$(cat nginx.pid)"
  PID USER     COMMAND
 4858 root     nginx: master process nginx -c /home/taro/yoyaku-web/nginx.conf
[終了コード 0]
$ grep -n client_max_body_size conf.d/yoyaku.conf
4:    client_max_body_size 1m;
[終了コード 0]
$ head -c 2097152 /dev/zero > /tmp/test_2mb.bin
[終了コード 0]
$ curl -s -o /dev/null -w '%{http_code}\n' -X POST --data-binary @/tmp/test_2mb.bin http://127.0.0.1:9890/upload
413
[終了コード 0]
$ df -h .
Filesystem      Size  Used Avail Use% Mounted on
/dev/vda        252G   35G  6.9G  84% /
[終了コード 0]

手順本体のログ

$ cp -p conf.d/yoyaku.conf conf.d/yoyaku.conf.bak_20261005
[終了コード 0]
$ diff conf.d/yoyaku.conf conf.d/yoyaku.conf.bak_20261005
[終了コード 0]
$ sed -i 's/client_max_body_size 1m;/client_max_body_size 20m;/' conf.d/yoyaku.conf
[終了コード 0]
$ diff conf.d/yoyaku.conf.bak_20261005 conf.d/yoyaku.conf
4c4
<     client_max_body_size 1m;
---
>     client_max_body_size 20m;
[終了コード 1]
$ nginx -c /home/taro/yoyaku-web/nginx.conf -t
nginx: the configuration file /home/taro/yoyaku-web/nginx.conf syntax is ok
nginx: configuration file /home/taro/yoyaku-web/nginx.conf test is successful
[終了コード 0]
$ nginx -c /home/taro/yoyaku-web/nginx.conf -s reload
2026/10/05 23:14:48 [notice] 4873#4873: signal process started
[終了コード 0]

事後確認のログ

$ curl -s -o /dev/null -w '%{http_code}\n' -X POST --data-binary @/tmp/test_2mb.bin http://127.0.0.1:9890/upload
200
[終了コード 0]
$ head -c 26214400 /dev/zero > /tmp/test_25mb.bin
[終了コード 0]
$ curl -s -o /dev/null -w '%{http_code}\n' -X POST --data-binary @/tmp/test_25mb.bin http://127.0.0.1:9890/upload
413
[終了コード 0]
$ curl -s http://127.0.0.1:9890/
yoyaku top
[終了コード 0]
$ grep -c -e emerg -e alert -e crit logs/error.log
0
[終了コード 1]
$ ps -o pid,user,args -p "$(cat nginx.pid)"
  PID USER     COMMAND
 4858 root     nginx: master process nginx -c /home/taro/yoyaku-web/nginx.conf
[終了コード 0]

切り戻しのログ

切り戻しは、使わずに済むのがいちばんですが、使えることを確かめておくと安心して作業に入れます。事後確認のあと、続けて切り戻しを通しました。

$ cp -p conf.d/yoyaku.conf.bak_20261005 conf.d/yoyaku.conf
[終了コード 0]
$ grep -n client_max_body_size conf.d/yoyaku.conf
4:    client_max_body_size 1m;
[終了コード 0]
$ nginx -c /home/taro/yoyaku-web/nginx.conf -t
nginx: the configuration file /home/taro/yoyaku-web/nginx.conf syntax is ok
nginx: configuration file /home/taro/yoyaku-web/nginx.conf test is successful
[終了コード 0]
$ nginx -c /home/taro/yoyaku-web/nginx.conf -s reload
2026/10/05 23:14:49 [notice] 4886#4886: signal process started
[終了コード 0]
$ curl -s -o /dev/null -w '%{http_code}\n' -X POST --data-binary @/tmp/test_2mb.bin http://127.0.0.1:9890/upload
413
[終了コード 0]
$ rm /tmp/test_2mb.bin /tmp/test_25mb.bin
[終了コード 0]

2MB の送信が 413 に戻り、変更前と同じ動作になりました。最後の rm は C-7 のテストファイルの削除です。

エラーになる例と、NG時の対応の書き方

「NG時の対応」の列は、起こりそうな表示を先に見ておくと具体的に書けます。手順 2 の書き換えで文字を誤った場合を、検証用の環境で再現しました。

行末の ; を落とした場合の手順 3 の出力です。

$ nginx -c /home/taro/yoyaku-web/nginx.conf -t
2026/10/05 23:08:01 [emerg] 1751#1751: directive "client_max_body_size" is not terminated by ";" in /home/taro/yoyaku-web/conf.d/yoyaku.conf:6
nginx: configuration file /home/taro/yoyaku-web/nginx.conf test failed
[終了コード 1]

値を 20mb と書いた場合の出力です。

$ nginx -c /home/taro/yoyaku-web/nginx.conf -t
2026/10/05 23:08:01 [emerg] 1753#1753: "client_max_body_size" directive invalid value in /home/taro/yoyaku-web/conf.d/yoyaku.conf:4
nginx: configuration file /home/taro/yoyaku-web/nginx.conf test failed
[終了コード 1]

この2つから、手順 3 の NG 時の対応は「[emerg] が出たら反映せず R-1 へ」と書けます。対応の書き方は次の3種類に絞ると、作業中に迷いません。

あいまいな表現の言い換え表

読む人によって操作が変わる言葉を、コマンド・値・番号に置き換えます。

レビュー用チェック項目30

書き終えたら、作業者以外の人がこの表で確かめます。タブ区切り版は表計算ソフトに貼って、結果の列に OK / NG を入れて使えます。

No  区分  チェック項目  結果
1   表紙と前提   目的が1文で書かれている    □
2   表紙と前提   対象のサーバー名とファイル名がフルパスで書かれている  □
3   表紙と前提   作業日時と所要時間の見込みが書かれている    □
4   表紙と前提   作業者と確認者が別の人になっている   □
5   表紙と前提   利用者への影響と停止の有無が書かれている    □
6   表紙と前提   中止・切り戻しの判断基準と判断者が書かれている □
7   手順の書き方  1つの行に操作が1つだけ書かれている  □
8   手順の書き方  コマンドはコピーしてそのまま貼れる形で書かれている   □
9   手順の書き方  コマンドを実行するディレクトリとユーザーが書かれている □
10  手順の書き方  ファイル名・値・行番号が具体的に書かれている（「適宜」「など」がない） □
11  手順の書き方  手順の番号が上から順に振られ、飛び先は番号で指定されている   □
12  手順の書き方  日付や版など毎回変わる部分に印が付いている   □
13  手順の書き方  取り消せない操作（削除・上書き）の前に確認の行がある  □
14  手順の書き方  待ち時間は秒や分の数値で書かれている  □
15  期待結果と確認 すべての行に期待結果が書かれている   □
16  期待結果と確認 期待結果は表示される文字列か数値で書かれている □
17  期待結果と確認 出力が何も出ないのが正しい行は「出力なし」と書かれている    □
18  期待結果と確認 事前確認に「変更前の値」を確かめる行がある   □
19  期待結果と確認 事後確認に「変更した機能」と「変更していない機能」の両方がある □
20  期待結果と確認 事後確認にログの確認が入っている    □
21  NG時の対応と切り戻し すべての行に NG 時の対応が書かれている   □
22  NG時の対応と切り戻し NG 時の行き先が番号（R-1 など）で書かれている  □
23  NG時の対応と切り戻し バックアップを取る行が変更より前にある □
24  NG時の対応と切り戻し バックアップが取れたことを確かめる行がある   □
25  NG時の対応と切り戻し 切り戻し手順にも期待結果と確認コマンドがある  □
26  NG時の対応と切り戻し 切り戻し後に「変更前の動作に戻った」ことを確かめる行がある   □
27  記録と保守   結果と時刻を書く欄がある    □
28  記録と保守   手順書と違った点を書く欄がある □
29  記録と保守   検証用の環境で一度通して実行し、期待結果を実際の出力に合わせてある   □
30  記録と保守   改訂履歴に版・日付・変更点が書かれている    □

確かめて分かったこと

記入例を実行して分かった、期待結果を書くときの注意点です。

1. sed -i は置換する文字列が見つからなくても、出力なし・終了コード 0 で終わります。 置換前の文字列を 2m と誤って実行したところ、エラーは出ず、ファイルも変わりませんでした。手順 2 の確認コマンドを diff にして「1か所だけ差分が出る」ことを期待結果にしているのはこのためです。
2. diff は差分があるとき終了コード 1 を返します。 手順 2 の確認では差分が出るのが正しいので、期待結果は終了コードではなく「4行目の1か所だけ差分が出る」と表示の内容で書きます。
3. grep -c は件数が 0 のとき、0 と表示して終了コード 1 を返します。 C-5 は「0 と表示」を期待結果にします。終了コードで判定する書き方にすると、良い結果を NG と読み違えます。
4. 文法に誤りのある設定で再読み込みを指示しても、nginx は変更前の設定のまま動き続けました。 20mb と書いた設定で -s reload を実行すると [emerg] が表示され、その後の 2MB の送信は直前の設定どおり 200 のままでした。nginx の公式ドキュメントにも、新しい設定を適用できないときは変更を取り消して以前の設定で動作を続けると書かれています。再読み込みの成否は、コマンドの表示に加えて事後確認の動作で確かめます。
5. バックアップのファイル名を .conf で終わる名前にすると、設定として読み込まれます。 conf.d/yoyaku_bak.conf という名前で置いたところ、nginx -t は成功しつつ conflicting server name "yoyaku.example.internal" on 127.0.0.1:9890, ignored という警告を出しました。記入例で yoyaku.conf.bak_20261005 としているのは、*.conf の読み込み対象から外すためです。

よくある質問

Q. 手順書とマニュアルの違いは何ですか？ A. 手順書は「この作業をこの順番で行う」を1行ずつ書いた文書で、マニュアルは仕組みや機能の全体を説明する文書です。手順書は上から順に実行するもの、マニュアルは必要な箇所を探して読むもの、と分けると書き分けやすくなります。

Q. 手順書はどこまで細かく書けばよいですか？ A. 「そのシステムを初めて触る人が、質問せずに最後まで進められる」細かさが目安です。ログイン先の確認、移動するディレクトリ、出力が出ない場合の「出力なし」まで書きます。

Q. 手順書は Excel と Markdown のどちらで作るのがよいですか？ A. 作業中に結果と時刻を書き込むなら表計算ソフト、変更の差分をレビューしたいなら Markdown が向いています。この記事のテンプレートは同じ列構成なので、どちらにも貼り付けられます。

Q. 切り戻し手順が書けない作業はどうすればよいですか？ A. 戻せない操作（データの削除など）の直前に「ここから先は戻せない」と明記し、その手前に確認者の判断を入れる行を置きます。あわせて、バックアップから復元する手順を切り戻しの代わりに書きます。

まとめ

• 手順書は 1行に1操作で、実行コマンド・期待結果・確認コマンド・NG時の対応を横に並べる。
• 期待結果は表示される文字列か数値で書き、「出力なし」も明記する。
• 構成は 表紙・事前確認・手順本体・事後確認・切り戻し・作業記録の6パート。
• 事前確認で変更前の値を、事後確認で変更した機能と変更していない機能の両方を確かめる。
• 切り戻しにも期待結果を書き、検証用の環境で一度通す。
• 「適宜」「正常に」「など」は、コマンド・値・番号に言い換える。
• 仕上げにチェック項目30で、作業者以外の人がレビューする。

参考・出典

• nginx 公式ドキュメント「Module ngx_http_core_module」client_max_body_size（https://nginx.org/en/docs/http/ngx_http_core_module.html）2026-10-05 閲覧
• nginx 公式ドキュメント「Controlling nginx」設定の再読み込み（https://nginx.org/en/docs/control.html）2026-10-05 閲覧

株式会社RJC ― SI事業・SES事業・AI駆動開発。RJCは一緒に成長を楽しめる会社です。