操作マニュアルの作り方!5つの心がけとは?
社内のマニュアル、現状に合わせて運用できていますか?
- そもそも分厚くて読む気がしない
- どこに何が書いてあるのか分かりにくい
- 読んでも理解できない
- 肝心なプロセスやトラブルの解決策が抜けがち
- 書いてある内容が古い(画像や説明が現状と異なる)
裏を返せば、マニュアルを作る側が、上記のような状態にならないように気をつけるべき項目でもあります。
今回は、システムの操作マニュアルに関して、私自身が分かりやすく使いやすいマニュアルを作るために心がけている5つのポイントをお伝えします。
<目次>
1.ユーザビリティ - 全体像・目的が把握できるフォーマットを
システムの操作時には、「こういう場合にはこの作業を行う」といったように、多数の分岐が発生します。そのため、操作マニュアルに記載されている作業内容が、どのパターンのときに、何のためにやることなのか、分からなくなることがしばしばあります。そこで、先に全体のシステムフロー図を作成し、そこに分岐とアクション(作業)を記載しておくことで、全体の流れと操作の位置づけを理解することができます。その際、アクションごとに番号を振って、その番号に沿って作業手順書を作成していけば、フロー図が目次の役目を果たし、利用者がより理解しやすくなります。
作業手順書に記載する項目には、アクション番号とアクション名、作業タイミング、作業者、作業の目的、前提条件、事後条件、参照資料、関連アクション番号などを設け、実施フロー(作業手順)と使用するシステムのメニュー名、作業上の注意事項を1セットとしてフォーマット化しておくと便利です。
2.細分化 – 検索性を高める工夫を
検索性を考慮して使いやすいマニュアルを作ろう
なお、マニュアルはとかくボリュームが増えがちですが、必ずしも一冊にまとめる必要はありません。読む気が失せるような分厚いマニュアルにならないよう、カテゴリ別に分冊化してインデックスを付けるなど、使いやすさに配慮しましょう。
また、1.でも触れましたが、別のマニュアルに詳しく書いてある内容であれば、そのアクション番号を記載しておく、関連作業は近接ページに配置するなど、目次以外でも検索性を高める工夫は可能です。どのようなキーワードで利用者がマニュアルを参照するのか、想像しながら作成しましょう。
3.シンプル - 利用者にとっての分かりやすさとは?
手順をテキストだけで書く、説明が冗長で文章量が多い、専門用語を多用するといった作り方では、利用者にとって分かりやすいマニュアルとは言えません。言葉での説明に加えて画像(画面キャプチャ)を利用し、実際に操作しているときと同じイメージで「見える」マニュアル作りを心がけましょう。直観的に何をすべきかが分かるマニュアルは、利用者に安心感を与えることができます。
最近では、動画によるマニュアルを導入するケースも増えています。これも、よりダイレクトに分かりやすいものが求められている背景があるのではないでしょうか。
4.先見性 - トラブル・疑問点を想定しておく
WEBサイトなどでもよく見かけるQ&A(「こういうときには、どうしたらいいのか?」)を、マニュアルにも盛り込んでおきましょう。もっとも、誰でも思いつくようなことばかりでは、あまり意味がありません。そのためにも、トラブルになりそうな操作については、作業手順書のフォーマットに「実施上の注意事項」を用意しておき、そこでカバーできるような作り方が求められます。
特に、システムの運用上、複雑な操作や他のシステムと連携するケースでは、マニュアルの参照頻度が多くなります。実際に作業を間違えてしまった場合のリカバリ方法も、近接ページにあると安心です。
5.メンテナンス性 - 更新しやすい作り方で風化を防ぐ
これまで挙げたことは、1回作成したらそれで終了、というものではありません。システムの更新時や機能追加・改修があった場合は、マニュアルも併せて更新する必要があります。年間を通じて使用するマニュアルであれば、利用者が気づいたときに都度マニュアルに赤入れし、年に一度集約するといった方法も効果的です。
更新を行わないでいると、次第に現実のシステムとマニュアル上のシステムに乖離が生じてしまい、マニュアルを見ても現状と同じ画面が見つからない、といったことにもなりかねません。
コメント機能や図形を多用しないシンプルなフォーマットでマニュアルを作成し、簡単に差し替えができるよう、作業ごとにページ(ファイル)を区切るなど、更新作業を軽減できるように工夫しましょう。
【関連記事】