読みやすく、正確に!インフラエンジニアのための、手順書作成・レビュー術
目次
【導入】
インフラエンジニアの業務において、手順書の存在はかかせません。
サーバ構築、ネットワーク設定、障害対応、リリース作業など、どの業務においても
「誰が読んでも同じ手順で、同じ結果が出る」という事が求められます。
その鍵を握るのが、正確で読みやすい手順書の作成・レビュー技術です。
しかし現場では、「この手順書、何をすればいいのかわかりづらい」「レビューしたはずなのに作業ミスが起きた」と言った声も多く聞かれます。
私も未経験からインフラエンジニアとして約2年間、現場で手順書を作成・レビューし、作業者として実行する立場を経験してきました。
その中で痛感したのが、【伝える力】の重要性です。
本記事では、インフラ業務における手順書の基本から、誰にでも伝わる文章・構成のテクニック、そしてレビューしてからのポイントまで、実践的に解説します。
【本文】
❶.手順書は「操作マニュアル」では無く、「意思疎通の道具」
まず意識しておきたいのが、手順書は単なる操作の羅列ではなく「コミュニケーションツール」であるという視点です。作成者と実行者が違うケースでは、「何を」「なぜ」「どうすればいいのか」が明確でなければ、誤操作や手戻りを引き起こします。
例えば以下の二つを比べてみてください：
❌NG例：コマンドを実行してOKです
⭕️OK例：以下のコマンドを実行して、エラーが出ない事確認してください
(ログは/var/log/setup.logに出力されます。)
後者のように、目的・結果・補足情報をセットで記述することで、作業者の理解を深め、想定外の状況にも対応しやすくなります。
❷.読みやすくするための5つの構成ルール
手順書を「読める」から「読みやすい」に昇華させるには、以下のルールを押さえましょう。
①セクション分けと見出しの活用
例：
markdown
コピーする
編集する
1.作業概要
2.作業前の準備(事前確認、バックアップ)
3.操作手順
4.作業後の確認
5.想定されるエラーと対処方法
②箇条書きと番号付けを明確に
複数の操作を記述する場合、順番がわかるように番号を振ること。
インデントで階層を明確にします。
③コマンドと説明を分ける
説明文とコマンドを明確に区別(例：太字、コードブロック、色分け)
ミス防止につながります。
④画像や図を活用
GUI操作ではスクリーンショットや手順書を併用することで、視覚的に理解しやすくなります。
⑤操作の目的を明示
「なぜこの操作をするのか」を一言添えるだけで、作業者の理解度が格段に上がります
❸.作成時に気をつけたい「よくある落とし穴」
省略語・社内用語の多用
➡️初心者や外注先にも伝わるかを意識。略語は初出時に必ず注釈や説明を。
前提条件の漏れ
➡️OSのバージョン、初期設定、必要な事前操作を明記する。
冗長な文章
➡️文は短く。1操作1文を意識すると読みやすくなります。
最新環境への更新もれ
➡️検証環境の差異やOSアップデート後のコマンド仕様に注意。
常にバージョンを確認
❹.レビュー術：安心して任せられる手順書とは？
手順書の品質は、レビュー段階で大きく変わります。
以下の観点でチェックしましょう。
| チェック項目 | 内容 |
|---|---|
| 手順に漏れがないか | 「やるべきこと」が全て記載されているか |
| 操作対象の明確化 | ホスト名、IPアドレス、ログイン情報は明記されているか。 |
| 表現が一貫しているか | 用語や表記揺れ(「ログイン」と「サインイン」)を統一。 |
| 結果の確認方法が明記されているか | 作業が成功かどうか、どう判断するかが書かれているか。 |
| 異常時の対応が記載されているか | 想定されるエラーとその対処法が含まれているか |
特に「レビュー者が実行者目線で読めているか」は重要です。
読み飛ばしを防ぐには、あえて“知らない人が読む前提”でチェックすることが効果的です。
❺.ツールやテンプレートを活用しよう
効率よく手順書を作成するには、テンプレートの活用やチーム標準が効果的です。
おすすめのフォーマットを下記に記載します。：
Excel手順書テンプレート(セクション・手順番号・コマンド・結果欄付き)
ConfluenceやNotionなどのドキュメント共有ツール
Markdown形式(GitHub Wikiで共有・管理)
また、レビュー履歴を残す文化を作ることで、再発防止や品質向上にもつながります。
【まとめ】
手順書は、作業の品質を左右する重要な成果物です。
「わかりやすさ」「正確さ」「誰が読んでも同じように作業できること」が求められます。
特にインフラ業務では、作業ミスが即システム障害に直結するため、
「書く技術」や「レビュー力」もエンジニアの重要なスキルの一部です。
現場で「ありがとう、この手順書めっちゃわかりやすい❗️」と言われたとき、
自分の文章力がチームや業務の信頼を支え得ていることを実感できるでしょう。
これから手順書に携わる方は、ぜひ「伝わる」ことを最優先に考えた設計と工夫を意識してみてください
その積み重ねが、あなた自身のエンジニアとしての信頼を築く土台になります。
