良いマニュアルを作るにはどうすれば良い？～陥りがちなダメマニュアルのポイント
こんにちは、ドキュメントハウスの本間です。
先日、ManualDock2をリリースして以来、多くのお問い合わせをいただいています。マニュアルについて悩みを抱える企業が多いのだなと実感するとともに、ManualDock2が多くの企業様のお役に立てそうだという確信を持てたことが大変嬉しかったです。
さて、ManualDock2に関連して、よく「ダメな製品マニュアルってどんなもの？」という質問を受けます。
社員として製品の開発プロセスを間近に見ていると、無意識に色々な前提知識が出来てしまい、その視点からマニュアルをつくってしまいがち。ただ、当然ですがマニュアルの読者はそうではありません。一番大切なのは、製品を初めて使うユーザーでもすぐに理解できる「ユーザー視点」のマニュアルであることです。
ユーザー視点のマニュアルをつくるには、意識すべき様々なポイントがあります。今日はマニュアルを作る際にやってしまいがちな代表的な問題をご紹介したいと思います。「当てはまる」と思われた方は、見直す機会に活用してください。
①デザインにこだわりがない
「必要な事項がカバーされていれば良い」という考えで、あまりデザインが意識されていないマニュアルも多々あります。しかし、あまりにデザインがずさんであれば、ユーザーは「マニュアルに力を入れていないな」「このマニュアルは大丈夫か？」と感じてしまうものです。
マニュアルは製品の一部であり、企業ブランドで大切な要素。
必要であれば外部のデザイナーを活用しつつ、目次構成やレイアウトを見た時に手に取りたくなる洗練されたデザインであるように努めましょう。
ただし、中にはデザインにこだわりすぎるあまり、ユーザーにとって分かりづらいマニュアルになることもしばしばあります。例えば、イラストだけで説明が全くないマニュアルもありますよね。マニュアル本来の目的はユーザーが目的を達成できること。あくまでそれを念頭に置いたバランスのよいデザインを心掛けましょう。
②文章が多すぎる
①のデザインとも関連しますが、マニュアル作成者には文章作成が好きな方が多く、うっかり陥りがちなのが文章が多いマニュアル。
日本では一般的にイラストを活用したマニュアルが好まれる傾向にあります。（※海外にはイラストをほとんど使わない習慣の国もあるので、日本での傾向です）
良いマニュアルにするには文章だけで説明しようとせず、イラストである程度分かるようにして、文章はあくまでビジュアルを補う位の立ち位置で構成しましょう。
ただし、イラストを活用していても、補足説明の文章が改ページによって別ページに記載されていたり、イラストがユーザーが操作する角度ではなくて分かりにくい、といった問題のあるマニュアルもしばしば見かけます。ユーザー目線で読みやすくなっているかはしっかり検証しましょう。
③技術者視点の目次構成になっている
よく、中小企業では技術者がマニュアルを制作することが多々あります。その時に起こりがちなのが、技術者の視点から作られているためにユーザーからは分かりにくいマニュアルです。
よくあるのが、目次構成が「目的」ではなくて「機能名」になっているもの。ユーザーは「xxxをしたい」という目的を持ってマニュアルを検索する人がほとんどです。しかし、目次が機能名別になっていて、機能名を知らなければどのページを見るべきなのか分からない、というマニュアルは数多くあります。
ユーザーが知りたい情報がどこのページに行けばすぐに分かるよう、「目的」や「キーワード」で検索できる構造にしましょう。キーワードも、技術者視点ではなくて、一般的に認知されているワードを選ぶことがポイントです。
④重要事項が、手順説明の後に書かれている
検索してページに飛んだら、いきなり手順説明で始まってしまうのも良くないマニュアルの特徴です。
「（操作の）目的」と「安全注意事項（PL関連事項）」を必ず手順説明の前に入れましょう。
いきなり手順説明から入るか、操作の目的がしっかりと明示されているかでその後の内容の頭への入りが大きく変わってきます。また、安全注意事項が手順説明の後に項目の最後にまとまっているマニュアルは意外と多いです。最初から読んで手順に従って操作を進めた時に、すでに安全注意事項に反する操作をしてしまっているということも有り得ます。トラブルを防ぐためにも、安全事項を確実に前に入れてください。
⑤マニュアル通りに操作してもその通りにならない
さて、これが一番クリティカルな問題です。「そんなことあるの？」と思われるかもしれませんが、意外と多いです。なぜこのようなことが起こるかというと、製品マニュアルの実行性の検証（実機検証）が行われていないから。製品開発中に仕様書をべ―スにマニュアル制作を始めていると、完成間近で発生したちょっとした設計変更や仕様変更が反映されないままになってしまいます。実際にマニュアル通りに動作するか実機検証をすることで簡単に防ぐことができるのですが、下流行程であるマニュアル制作は時間がなく、意外とスキップされてしまう企業が多いのが実情です。
最近では減ってきましたが、まだまだ多いのがこのパターンです。
マニュアルの信頼性に関わって来るので絶対に実機検証をしましょう。
色々なポイントを書いてみましたがいかがでしょうか。繰り返しになりますが大事なのは「ユーザー視点」であること。
「当てはまる」「もっと気を付けるポイントを知りたい」と思われた方は、ManualDock2で是非補完してほしいなと思っています。国際規格「IEC82079-1」の中でも特に重要な100項目を評価することが可能です。
令和２年度第３次補正 事業再構築補助金により作成