マニュアル作成の担当者になったばかりのころ、どうやって書き始めたらいいのかわかりませんでした。
そしていざ作ってはみたものの、カスタマーサービスへの問い合わせは減らず、どうしたらいいのか悩みました。
今回は私の経験から、マニュアル作成の担当者になったばかりのかたに「これだけは押さえてほしい!」と感じているマニュアル作成のポイントをまとめました。
参考になればうれしいです。
んでは、どうぞ!
■ 目次
誰に対して書くのか決める
対象の製品を使い始めたばかりの初心者なのか、使い慣れているシステム担当者なのか、読み手のターゲットを決めます。
わたしの場合、次のようにターゲットを設定しています。
- システム担当者を任されたばかり
- 製品を操作するのはこの会社がはじめて
- ワードやエクセルなどパソコンは使えるけれど、システムのことは詳しくない
- 30代前半、女性
ターゲットを決めることで、どのくらいのレベルで書いていけばいいのか意識することができます。
マニュアル全体のレベルを統一することができます。
たとえば説明箇所によって、「Aの箇所は操作例があるのに、Bの箇所はない」といった違いをなくします。
マニュアルはたいてい必要なときしか読まれません。
欲しい情報が書かれていなかった場合、顧客である読み手は製品に対して使いにくいと感じてしまうでしょう。
読み手にとって必要な情報を提供するために、どのような情報を記載しておくべきか考えることは大切です。
目次をおろそかにしない!見出しのタイトルで何が書かれているか伝える
目次には、何十ページもあるマニュアルから読み手が必要な情報の場所をお知らせする役割があります。
読み手がマニュアルを開いて、一番に見るのが目次です。目次に書かれた見出しを見て、求めている情報がどのページに書かれているのか探します。
しかし、見出しの中から求めている情報のキーワードがない場合、読み手はマニュアルを手放すでしょう。
たとえマニュアルに書いていても、読み手の疑問は解消されていません。
目次には読み手に欲しい情報があることをお知らせするためにも力を入れることは大切です。
別記事で見出しタイトルの付け方、目次の作り方について書いています。よかったら読んでください。
参考URL:
分かりやすいマニュアルの目次を書くときに気をつけたい3個のポイント
書き終わったら、最後に文章をチェックする
マニュアルを一通り書き終わったら、チェックをしましょう。
誤字や脱字、PDFであれば不要な白紙ページ、webサイトであればURL間違いなど、間違いがないか確認します。
もしも読み手が間違いを見つけたら、どう感じるでしょうか。利用している製品の使い方がわからなくて調べていて、解決方法が書かれた箇所に間違いがあったらどうでしょうか。いつまでも疑問を解決できません。
読み手であるユーザーは製品を信頼しなくなるかもしれません。
マニュアルも製品の一部です。
ユーザーが安心して利用できるマニュアルであることが大切です。
そのためにマニュアルを一通り書き終わったら、次のことをチェックしてみてください。
どのマニュアルでも共通して確認が必要な項目です。
- 誤字や脱字
- PDFであれば、不要な白紙ページ
- webサイトであれば、URLの間違い
- 目次番号、ページ番号の間違い
- 挿入画像の間違い
まとめ
マニュアルを目にすることは多いです。
しかし、いざ書こうとすると書けないものです、
マニュアルには書き方のコツがあります。
コツを知るだけで、迷わずに書くことができます。
読み手のターゲットを決めること、見出しを作り込むこと、間違いがないか確認することを意識するだけで、マニュアルは書きやすくなります。
ぜひ、基本の基本として心がけてください。