手順書を書く際に心がける5つのポイント

こんにちは。Ichikawaです。

最近、業務内でインフラ環境構築の手順書作成を行うことがありました。
私はマイロプスに入るまで「手順書」というものは作成経験がなく(いわゆる「業務マニュアル」はあった)、手順書を作る中で上司から様々なレビューを受けました。

そのレビューの中で、今後手順書作成をする際に特に気をつけたいポイントをピックアップしようと思います。

①手順書と情報マニュアルは別物。手順書には「手順のみ」を書く

当たり前と言えば当たり前ですが、手順書の様式に慣れていなかった私にとってはかなり苦労したポイントでした。

手順書は「ある作業を行う際の具体的な手順を記載した書類」であり、「ある作業を行う際の概要や情報をまとめた書類」であるマニュアルとは似て非なるものでした。
私は当初その点を理解できておらず、初稿で「〇〇に気をつける」や「××するとよい」などといったアドバイス的な記載を至るところに書いていました。

あくまで手順書は具体的な手順を書く書類です。どうしても手順以外の記載を入れたい場合は、そのような記載と手順を明確に分けて書くようにした方が良いです。

②フローの画像を貼り、作業過程をなるべく可視化する

言葉だけでの説明だとわかりにくい際は画像もセットで載せてあげると読み手がイメージしやすくなります。

例えば次のような記載があったとします。

  1. サイトAに飛び、ホーム画面右上にあるアイコンボタンをクリックする
  2. アイコンボタンを押すと設定画面に遷移する。設定画面の左側にあるボタンをクリックする
  3. クリック先でフォームの記載内容を入力する

おそらく「ホーム画面の右上はどこ?」「アイコンボタンはどこ?」といった疑問が生じるのではないでしょうか。
この場合はホーム画面や設定画面のスクリーンショットを載せることで、疑問が解消されてわかりやすい手順書となります。

③記載場所が一意に定まるナンバリングを意識する

この点も私が初稿で指摘され、今まで無意識に使っていたためハッとさせられた部分です。

手順書内には、ある手順の説明で事前に行った説明を参照したい箇所が出てくることがあります。
その際適切なナンバリングでないと、場所を参照しにくくなり読み手のコストが上がってしまいます。

例えば大見出しで①〜⑤、各見出し内の小見出しで(1)〜(5)といった形でナンバリングしていたとします。
ここで①の作業の(1)番目を参照させたいときに、単に(1)とだけ書いていては伝わらない。ということです。

対策の例として、大見出しと小見出しを繋げたナンバリングにすることをレビューされました。
大見出しは(1)〜(5)の場合、小見出しを(1-1)〜(1-5)、(2-1)... と記載する形です。そうすると番号を見ただけで参照している場所が一意に定まるということです。

④チェック事項や完了条件等を主観的にせずすべて具体的に書く

指示書にとって大事なことは誰が読んでも同じ手順で作業が進められることです。
そのため、確認すべき事項がある場合は誰が読んでも同じような確認をできるような書き方が求められます。

例えば「正しく動くか確認すること」と書かれていた場合、読み手にとっては「正しく動く状態はどんな状態?」という疑問を持たせる書き方になってしまいます。
この場合は正しく動く条件を細分化・言語化し、どのように動けば正しい挙動なのかを指示書の中で示してあげる必要があります。

⑤手順書を自分で実際にテストし、記載通りの内容で問題ないか確認する

手順書にミスがないか確認するために、記載内容をテストすることも重要です。

手順書の作者は頭の中で作業フローを把握している状態のため、つい「わかっている前提」で特定の手順を飛ばしたり抽象的な記述になっている可能性があります。
それを防ぐためにも記載内容通りの作業をして同じように動作するかまで確認する必要があります。

最後に

ここまでご覧いただきありがとうございます。

手順書の作成スキルが上がることで社内のワークフローをより浸透させることができるため、社内の業務効率化や業務引き継ぎの確実化につながります。

明確で誰が読んでもわかる手順書を作れるようにみなさんで心がけていきたいものですね。

Ichikawa

フロントエンドエンジニア

Webデザイナー兼コーダーからフロントエンドエンジニアに転身。
野球とゲームが好き。
自分の武器を増やすべく、日々研鑽中。

関連記事

お仕事のご相談、採用についてなど、お気軽にお問い合わせください。