手順書は、作業内容さえ書いてあればよいというものではありません。
私がSEとして手順書を作っていたときは、内容だけでなく、どこに何が書かれているのか、どの順番で見ればよいのかまで分かるようにすることを意識していました。
特に重要だったのが、共通テンプレートです。
人によって書き方が違うと、手順書を開くたびに「今回はどう読めばいいのか」を確認するところから始めることになります。
私が担当していた現場では、新人でも使えるレベルまで手順を落とし込むことが多くありました。
この記事では、私がSEとして手順書を作るときに意識していた、共通テンプレート、画像の使い方、注意事項の見せ方などを紹介します。
手順書は共通テンプレートを使うようにしていた
私が手順書を作るときは、できるだけ共通テンプレートを使うようにしていました。
テンプレートには、例えば次のような項目を用意していました。
- 表紙
- 必要に応じた目次
- 概要
- どの作業を想定した手順書なのか
- 前提条件
- 詳細な作業手順
- 必要に応じた切り戻し方法
- 既存の障害内容に対する対応方法
- エラー時の連絡先
すべての手順書に同じ項目を入れていたわけではありません。
作業内容によって不要な項目もあるため、必要なものを選びながら使っていました。
画像については独立した項目というより、詳細手順の中で説明文に対応する位置へ配置していました。
基本的な配置や書き方を揃えておくことで、別の手順書を開いたときにも、どこを見ればよいのか判断しやすくしていました。
テンプレートが揃っていない手順書は読むだけでも時間がかかった
テンプレートが揃っていない手順書は、内容以前に「どう読めばよいのか」を考える必要があります。
例えば、左から読めばよいのか右から読めばよいのか、注意事項はどこにあるのか、Excelならどのシートを見ればよいのかといったことを、手順書ごとに判断しなければなりません。
一つだけであれば、慣れれば読むことはできます。
ただ、何個も手順書を読む場合、そのたびに別の書き方を覚える必要があり、時間がかかって仕方がありませんでした。
私にとって共通テンプレートの大きな利点は、見た目を揃えることそのものではなく、手順書の読み方を毎回覚え直さなくてよくなることでした。
スクリーンショットは説明文と同じ画面を使っていた
画面操作を説明するときは、説明文に対応したスクリーンショットを入れていました。
そのまま画像を貼るだけでは、画面のどこを見ればよいのか分からないことがあります。
そこで、説明している対象箇所を赤枠で囲むようにしていました。
必要であれば、①、②、③といった番号も画像へ入れます。
これによって、
「この説明は画面のどこを指しているのか」
「どの順番で操作すればよいのか」
を追いやすくしていました。
私の場合、スクリーンショットは単に画面を見せるためではなく、操作対象と操作順を明示するために使っていました。
注意事項は普通の手順と見た目を変えていた
注意事項や危険な操作は、通常の説明文と同じ見た目にはしていませんでした。
私が作っていた手順書では、重要な注意事項を通常よりかなり大きな文字にし、太字・赤字で表示することがありました。
感覚としては、通常の文字の2倍程度まで大きくすることもありました。
特に重要な事前作業がある場合には、
「この作業を実施したか」
と、作業前にもう一度確認させるような記載を入れることもありました。
注意事項は、記載するだけでなく、通常の手順とは見た目を変えて見落としにくくすることを意識していました。
新人でも使えるレベルまで落とし込むことが多かった
手順書は、自分が分かればよいものとして作るのではなく、新人でも使えるレベルまで落とし込むことが多くありました。
私がそうしていた理由の一つは、メンバーが病気やけがで急にいなくなった場合でも、基本的な業務を続けられる状態にしておきたいと考えていたためです。
そのため、
「普段この作業をしている人なら分かる」
という前提ではなく、
「初めて見る人でも順番に進められるか」
という視点で作るようにしていました。
もちろん、すべての作業を誰でもできるようにするという意味ではありません。
それでも、特定の人しか手順を理解できない状態をできるだけ避けるため、基本的な作業は手順書を見ながら進められる形を意識していました。
引き継ぎでは、手順書を渡して説明するだけでなく、後任に実際の作業をしてもらうこともありました。
詳しくは、SEの引き継ぎで意識していたこと｜資料だけで終わらせず後任に実作業してもらった経験から解説で紹介しています。
相手によって手順書の作り込みを変えていた
手順書の作り込みは、誰が使うのかによって変えていました。
例えば、オペレーター向けなど、社外へ渡す手順書では、内部向けよりもフォーマットを厳密に整えることがありました。
手順番号も、
1-1-1
1-1-2
1-2-1
のように揃え、必要な画像も用意します。
一方で、内部で使う手順書では、そこまで厳密に整えずに作ることもありました。
誰に渡すものなのか、どの程度初見で使える必要があるのかによって、作り込みの程度を変えていました。
新人に手順書を整えてもらうこともあった
既存の手順書を、新人にきれいに整えてもらうこともありました。
単に資料作成を任せるだけではありません。
人が読む資料では、内容だけでなく見た目も重要だと考えていたためです。
配置が揃っていない、注意事項の場所が毎回違う、画像がどの説明に対応しているか分からないといった状態では、内容が正しくても読みづらくなります。
実際に手順書を整えてもらうことで、
「自分が分かる資料」と
「他の人が見て分かる資料」
は違うということを意識してもらう意味もありました。
私自身も、手順書では内容の正しさだけでなく、相手が迷わず読める形になっているかを見るようにしていました。
まとめ：手順書は内容だけでなく読み方まで揃えるようにしていた
私がSEとして手順書を作るときは、作業内容を書くだけではなく、共通テンプレートを使って読み方まで揃えることを意識していました。
スクリーンショットでは対象箇所を赤枠で囲み、必要なら番号を付けて操作順を分かりやすくしていました。
注意事項は大きな文字や太字、赤字にして、通常の手順とは見た目を変えていました。
また、新人でも使えるレベルまで内容を落とし込み、使う相手によってフォーマットや説明の細かさを変えることもありました。
私の経験では、手順書で大切なのは情報をたくさん書くことではなく、初めて読む人が、どこを見て、何をすればよいのか迷わない形にすることでした。
