【新人ITエンジニア必見】作業手順書の作成で気を付けること

サーバエンジニアやネットワークエンジニア、インフラエンジニアなど、様々な新人ITエンジニアが任されやすい仕事の１つに「作業手順書の作成」があります。

しかし、この作業手順書の作成は新人ITエンジニア向けの簡単な業務ではなく、作業内容に関する様々な知見やノウハウと高い文書作成能力を問われるため、苦労している方も多いのではないでしょうか。

本記事では、作業手順書は何のために作成するの？どのように作成する？どうしたら上司やユーザの満足いく作業手順書を作れるの？うまく作成する方法は無いの？といった声にお応えしたいと思います。

作業手順書の定義、対象読者

“エンジニア”というと、IT分野だけでなく車、機械、色々なエンジニアがいます。それぞれのエンジニアで実施する作業内容は異なりますが、それら作業の特徴に合わせた作業手順書を作ります。

この記事の対象はITエンジニア、その中でもシステム構築に携わる、インフラエンジニア、開発エンジニア、運用エンジニアを対象読者とし、当該エンジニアが作成する可能性のある作業手順書について説明していきます。

具体的に想定する作業として、システムに対する構築作業、テスト作業、移行作業、運用・保守作業などを想定していますので、それら業務に携わる各エンジニアの方は是非とも参考にされてください。

作業手順書を作成する意味

わざわざ作業手順書を起こす意義について考えてみたいと思います。

スムーズに作業できる

何か作業を行う際、きちんと計画を立てて行うことは重要なことです。どのような作業をするのか、どのような体制で作業するのか、全体あるいは個々の作業でどれくらいの時間を要するのか計画を立てることで、スムーズに作業を実施できます。

未計画な状態で作業を実施してしまうと、想定時間内に作業が終わらない、事前に必要な準備ができていない、必要な道具が揃っていないなどで作業を開始できない、途中で中断せざるを得ないなどのトラブルになりかねません。

安全に作業できる

作業手順書を起こすことで、手順を確認しながら安全に作業を実施できます。手順書に無い手順は実施しない、どうしても必要な手順が漏れていた場合は相談する等のルールを決めておくことで、作業におけるリスクを回避することができます。

作業当日になって場当たり的に作業を実施してしまうと、誤った操作等を行ってシステム障害等のインシデントを引き起こす恐れもあります。

予定作業時間の妥当性を確認できる

作業を計画する際、予定作業時間を必ず見積ります。１手順単位でどれ程時間を要するかを見積ることで、作業全体が予定作業時間内に収まるかが分かり、仮に予定に収まらない場合は作業範囲の縮小やスケジュールの再調整を判断することもできます。

余計な作業は、作業人員の人件費コストなどに大きな影響を及ぼすので、前もって計算しておく必要があります。

作業手順の問題点やリスクを確認できる

作業手順書を詳細に起こすことで、各手順における方法、手順の実施順序、タイミング等に問題が無いか改めて確認できます。

よりリスクの低い安全な操作、効率の良い手順にブラッシュアップできれば、質の高い作業手順書として残すことができ、他作業の手順書を作る際にも参考にすることができます。

関係者間で認識を共有・共通化できる

作成した作業手順書を関係者間でチェックすることで、スケジュール感や具体的な手順内容について共通認識を持つことができます。複数チームに分かれて作業を実施する場合、それぞれのチームがどのような作業を行うのかを認識しておくことで、うまく連携を取りながら作業を進めることができます。

また、新人エンジニアに手順書を作成させる意義はここにあり、作業内容やスケジュール感覚について、新人に具体的なイメージを持ってもらいたいという意図が考えられます。

作業の属人化を避けることができる

作業手順書に起こすことで、手順を実施する人間が変わっても作業手順を遂行することができます。作業当日に事故や病気で担当者が来られず、代わりに予備の人員が作業をすることもあります。
そのため、誰が見ても実施できるように作業手順書を作成する必要があります。

手順書作成が難しい理由

作業手順書作成は、新人エンジニアがよく任される業務ではありますが、次のような理由で決して簡単な業務とは言えません。新人に任せるには難し過ぎる作業のように感じるかもしれませんが、業務を任せた側からそれだけ期待されているのかもしれません。

手順の内容に深い理解が求められる

作業手順書の手順は、「クリックする」、「次のコマンドを実行する」といった詳細なレベルで記載するケースが多いです。これら一つ一つの手順を起こすためには、その手順を実施するための前提条件や手順を実施すると何が起きるのか、深いレベルで手順に対する理解が求められます。

また、並行して実施可能な作業、そうでない作業、手順を実施することで問題が起きた場合のリカバリや切り戻しについても理解する必要があり高度な知見が求められます。

作業時間の制限を考慮しないといけない

作業手順書の作成を依頼された時、作業日時や予定作業時間は既に決められていることが多いです。決められた予定作業時間に収まるように手順を起こす必要があり、どうしても収まりそうにない時は、他の作業関係者が納得できるような根拠を用意して説得します。
そのため、効率を追及した作業手順を組み立てる思考力と、根拠を以て自分の考えを他人に説明する能力が求められます。

すべての作業関係者が読むことを想定する

作業手順書は、その作業に関係するすべての作業関係者が目にすることになる、そういう心構えで作成に臨むべきです。ここで言う作業関係者とは、IT技術者だけでなく、案件依頼元のユーザも含みます。
そのため、誰が見ても内容を理解できるドキュメントを作成する能力が求められます。

手順書内で使用する用語はプロジェクトで定められた用語に統一しましょう。文字のフォントサイズや書式、印刷設定等のドキュメント体裁についても、プロジェクトのルールがあるのであれば徹底して従うようにしましょう。

基本的な作業手順書の作り方

基本的な作業手順書の作り方を説明します。
今回は、次の状況を想定して作業手順書を考える流れで、作り方を説明してみます。

AWS上にあるWindowsインスタンスを起動し、ソフトウェアをインストールする
インストール完了後、Windowsインスタンスを停止する
予定作業日時は、2024/11/18～2024/11/19 PM20:00～20:40

手順の大枠を整理する

まずは作業手順書の大枠を整理しましょう。細かいコマンドの実行やツールの使い方ではなく、目次レベルで何をするかの整理です。今回は、AWSクラウド上のインスタンスにソフトウェアをインストールする手順を想定し、次のように大枠を整理してみました。

AWSクラウドへのサインイン
Windowsインスタンスの起動
ソフトウェアのインストール
Windowsインスタンスの停止
AWSクラウドからのサインアウト

詳細な手順を書き出す

大枠で整理した手順をより詳細なレベルに掘り下げます。それぞれの手順は数分単位で作業時間を見積り、作業予定担当者も記載しましょう。作業手順書のフォーマットを確認し、指定のものがあるのであればそれを使用しましょう。

▼詳細な作業手順書の例

ここで掘り下げる手順の正確さを高めるには、検証可能な手順はなるべく実際に手を動かして確かめるのが良いです。作業を実施する環境での検証は難しい場合が多いですが、事前に確認できるものは確認しておきましょう。

手順に過不足が無いかの確認

作成した手順を見直して、過不足が無いかの確認をしましょう。

事前に必要なサインイン操作、ログイン操作は記載しているか
同じ作業を２度続けて実施していないか
手順の実施結果に対する確認方法が重複していないか

ただ、まだ十分な知識や経験が無い新人の段階では、何が過不足なのか判断が付かない箇所も多々あると思います。そういう時は、判断が付きそうな周りの人間に相談することも当然アリです。

手順の整合性や妥当性を確認

手順の整合性や妥当性も確認しましょう。例えば、次のようなポイントを確認します。

前提条件がある作業について、実施タイミングでその条件が満たされるか
例）事前に完了しておくべき処理がある（業務ジョブや定期バックアップ処理など）
他チームと並行して作業を実施する場合、作業実施タイミングの整合は取れているか
切り戻し作業を実施する場合、実施判断ポイントの設定時間は正しいか
（作業終了予定時間から逆算して計算内に収まるか）

これらのポイントはあくまでも一例ですが、整合性や妥当性に関する指摘は、どの作業手順書にも通ずる場合があります。日頃から作業手順書のレビュー等で挙がる整合性、妥当性関連の指摘をリスト化しておき、チェックリストとして活用すると良いでしょう。

ドキュメントとしての体裁チェック

第３者レビューを受ける前に、ドキュメント体裁をセルフチェックしましょう。

例えば、文字フォントの種類や大きさ、誤字脱字や曖昧語、プロジェクトで定義された用語ルールに沿った文言を記載しているか、印刷する場合は印刷ルールに沿っているかなどがドキュメント体裁チェックに該当します。

後に控える第三者レビューで、これらのドキュメント体裁に関する指摘を受けると、気を付ければ防げた指摘が増え、作業手順書の品質が低いと判断されることになりかねません。まだ知識や経験が浅い新人エンジニアでも、ドキュメント体裁に注意を払うことは可能ですので、気を付けたいところです。

ドキュメント体裁チェックは、”できて当たり前”のことだと認識するベテランエンジニアも多いですが、ドキュメント作成が苦手なエンジニアも少なからず存在します。したがって、新人のうちからドキュメント体裁を自分でチェックできれば、大きなスキルになるはずです。

第三者レビューを受ける

作成した作業手順書は、第三者によるレビューを受けるようにしましょう。大抵は、作業手順書を作成するタスクとレビューがセットになっていることが多いですが、ちょっとした作業だとそうでないかもしれません。

しかし、仮にレビューがタスクとしてセットになっていない場合も、次の理由で自ら第三者レビューを受けた方が良いです。

作業手順書の品質向上を期待できる
作業手順書に関する作成責任を一人で抱え込むリスクを回避できる
作業計画について共有されていない条件などが明らかになる場合がある

レビュー指摘への対応

第三者レビューで指摘された内容について、対処が必要なものは修正を行います。また、対処の必要がない指摘についても、どのような理由で対処しなかったのか記録しておきます。対処した結果は第三者に共有し、承認をもらうようにしましょう。

ここまでやれば、あとは作業に臨むだけという状態になります。

手順書作成の応用テクニック

作業手順書の作り方について説明しましたが、ここでは応用編として作業手順書作成におけるテクニックを紹介します。

作業手順で実行するコマンドは手打ちしないようにする

コマンドの実行は、慎重に行う必要があります。データの更新や削除を行うコマンドを誤って実行した場合、余計な手戻りやタイムロス、最悪の場合はインシデントとなり得ます。

データを参照するだけのコマンドでも、コマンド内容やタイミングによっては余計な処理で負荷が掛かり、他の作業に影響を及ぼすかもしれません。

コマンドの誤実行を防ぐために、なるべくコマンドを手打ちしない作業手順にしましょう。例えば、実行するコマンドを記載したファイルを用意し、作業中はそのファイルからプロンプトへ実行コマンドをコピー＆ペーストして実行するといった対策が可能です。以下は、手順の記載例です。

デスクトップに配置したファイル「cmd_list.txt」より、userdel -r old_user をコピー&ペーストでプロンプトに貼り付けて実行

他にも、以下の手順記載例のように補完入力機能（先頭の数文字を入力することで、後に続く文字列を自動入力する機能）を利用することで手打ち入力の部分を減らすことができます。

Linuxサーバkakin_lin01 にて、tabキー補完を利用してdnf list installed traceroute を実行

事前に実施可能な作業手順はなるべく事前に実施する方針で

作業当日を待たず、事前に実施可能な手順はなるべく事前に実施するようにしましょう。例えば、ファイルを配置するだけの作業、ソフトウェアのバージョンアップ作業に伴う現行バージョンの削除などです。

事前に実施可能な作業を手順から削ることで、１作業における作業ボリュームが減り、作業時間に余裕を持たせることができます。

注意すべきは、事前に実施可能な手順については慎重に確認する必要がある点です。容易に作業環境を扱えない場合、単なるファイル配置作業でも実施許可が出ないこともあります。また、先述のソフトウェアのバージョンアップ作業に関しても、現行バージョンを削除して現行業務に影響が生じる場合も考えられます。

作業中にチェックリストを活用する

複数のデータを一挙に変更する作業などでは、チェックリストを用意しておくと作業効率や安全性の面で有効な場合があります。

例えば、複数のデータを移行する作業の場合、あらかじめ移行対象となるデータのリストを用意しておきます。移行作業直後、移行対象のデータが移行先にすべて移行されているかをチェックリストで確認できれば、移行漏れを防止できます。

何千何万といった大量のデータを変更する場合も、対象データのファイル数や総サイズ容量を前もって控えておき、作業後の状態との比較で確認可能です。

目視確認作業をなるべく減らす

目視確認作業とは、文字の通り目で見て確認する作業のことです。目視での確認には見落としや見誤りのリスクがあり、確認結果が証拠として残らないという問題点もあります。

例えば、ファイル内容の変更は、比較コマンドやツールを使用することで差分を正確に把握することができます。人間の目で見て確認するよりも正確に差分を確認でき、比較結果や差分をエビデンスとして残すことも可能なため、なるべくコマンドやツールを用いて確認する方法を採用するようにしましょう。

また、作業手順書のドキュメント体裁チェックでも、目視でチェックを行わないように心掛けると質の高い手順書を作成できます。例えば、Office製品で作業手順書を作成する場合、用語の検索や修正は検索機能や置換機能で行うことができます。

他にも、ドキュメント内の曖昧語や表記揺れを検出するツールが数多くインターネットで公開されています。目で見て確認するより断然信頼度が高く、チェック効率も上がるため積極的に活用しましょう。

便利な作業手順書作成ツール

作業手順書作成において、使用すると便利なツールをいくつか紹介します。

comp/diff

compは、Windows OS標準で搭載されている比較コマンドであり、ソフトウェアを追加でインストールせずとも使用できるのが利点です。diffは、Linux OS標準で搭載されている比較コマンドです。それぞれのコマンドリファレンスを確認したうえで、用意されたオプションをうまく利用して比較を行いましょう。