• 東京03-5321-3111
  • 名古屋052-269-8016

マニュアル作成6つのポイント

マニュアル作成
6つのポイント

マニュアル作成~失敗例から学ぶ6つの落とし穴

企業が作成する必要のある取扱説明書や業務手順などのマニュアル作成は、いざやろうとすると、さまざまなところで壁にぶつかることが多くあります。
今回は、そのマニュアル作成におけるよくある落とし穴を5つ取り上げ、それぞれの課題に対して、有効な解決策のヒントをご紹介します。

マニュアル作成でよくある課題(1)
文章が読みづらい

マニュアル作成でよくある課題の一つに、「文章が読みづらい」ということがあります。そこで、マニュアルの文章が読みづらいというよくある3つの課題と解決策について解説します。

課題①

同じ内容を説明する際の用字用語や表現が統一されていない
例.「手で動かす」「手動で制御」「手動動作」など表現が不統一。

解決策①

この場合、用字用語や表現、文体を統一する執筆ルールを定めたり、チェックシートを作成して適用したりするのをおすすめします。こうした明確な基準があることで、マニュアルユーザーの混乱を防ぎ、更新にも余計な手間がかからなくなります。


課題②

主語・述語の係り受けが正しくない 例.「この機能は、特定の用途によって動作することです。」など、本来「動作します。」が正しい述語であるのにもかかわらず、主語とねじれてしまっている、など。

解決策②

この場合、正しい文章の書き方を知ることが第一です。さらに、記載する情報の粒度を把握することで解決できます。例えば、「機能」と「具体例」を伝えたい場合、両方、1つの文に記載するのではなく、2つの文に分けて記載するといった形です。


課題③

「ですます」調の中に、「~いただく」「いたします」「ございます」「ご提供」などの丁寧する文章や、「である調」の文章が混在している

解決策③

マニュアルでは基本的に、「ですます」の丁寧語で統一します。
この場合も、明確に文体を統一する執筆ルールやチェックシートの適用が有効です。

マニュアル作成でよくある課題(2)
どこに書かれているか探しづらい
【目次・参照先編】

目次・参照先の書き方が不適切であるため、どこに何が書かれているのか分からない、という課題です。これもマニュアル作成でよくある落とし穴といえます。

課題①

各目次において情報量の差異が大きすぎて構成がアンバランスになっている
例.1章から5章まであるマニュアルで、1~4章は合計しても数ページしかなく、且つ2~4章は章タイトルしかないにも関わらず、5章は100ページ近くある状態になっている、など。

解決策①

上記の例のようなアンバランスさがある場合、章タイトルのみの部分も含む2~4章は概要としてまとめ直し、ボリュームのある5章の各節は章に格上げしたりするなど、内容に応じていくつかの章にグルーピングすると、より見やすい構成になります。


課題②

目次自体の情報量が多すぎて検索性が低い。
例.目次の階層が深い、目次に登場しない見出しがある、など。

解決策②

目次については、通常の目次として「メインの目次」のほかに、別途、マニュアルユーザーにとっての目的別に探せる目次など、目的に応じて目次をいくつか付与することで、検索性が高くなります。

具体的に、システムの操作マニュアルの場合の例を挙げます。

a.目次(メインの目次)

メインの目次については、例えば、「導入⇒設定⇒オプション選択」などと、そのシステムの現場の流れに沿った目次を作成します。そして散在している情報を目次に沿ってまとめて再整理すると見やすくなります。

b.目的別目次

マニュアル使用者の操作目的別に切り分けると分かりやすくなります。例えば、「ファイルをアップロードする」「パスワードを設定する」など、操作目的ごとに説明を記載した参照先ページを追加するとより親切です。

c.プラン別目次

そのマニュアルのシステムに複数の利用プランがあり、プランによって機能が異なる場合、各プランと、プランに含まれる機能の対応表を追加すると分かりやすくなります。

このように目次を分けることによって、検索性も上がり、有用なマニュアルになります。


課題③

文章内の参照先の案内を見ても欲しい情報が見当たらない
例.「これについては、『2.導入編 2-1.初期設定』を参照してください。」と記載されているが、実際に初期設定のページのどこを見ればいいのか分からない、欲しい情報があるのか分からない、など。

解決策③

参照先を示す際に、ページ番号だけでなく、見出し名も示すことがポイントです。
そして参照先の記載方法に限らず、同じ内容を示す表現は、今閲覧している文章内と統一することで、より分かりやすくなります。

マニュアル作成でよくある課題(3)
どこに書かれているか探しづらい【情報構造編】

文章内の情報構造が統一されていないことで、どこに何が書かれているのか分からない、という課題もよくあります。

課題①

段落内の情報が整理されておらず、必要な情報が見つけづらい
例.長文で区切りなく書かれている、など。

解決策①

この場合、まず文章全体に記載されている情報を整理します。情報の種類ごとにグルーピングし、それぞれのグループごとに記載位置をまとめることで必要な情報を見つけやすくなります。


課題②

見出しや注意書きなどのデザインが統一されておらず、視覚的に重要な情報や情報の種類が判別しづらい
例.ある見出しには「■」が付けられているのに、他の見出しには「■」が付けられていない、同じレベルの見出しなのにフォントの大きさが異なる、など。

解決策②

この場合、見出しや箇条書きなどのデザインは統一して、情報の種類や重要度が一目でわかるようにすることがポイントです。

マニュアル作成でよくある課題(4)
どこに書かれているか探しづらい
【Webマニュアル編】

続いては、Webアプリなどの操作手順書でよくある課題と解決策をご紹介します。

課題

さまざまな情報が同じ文字サイズ、太さ、フォントで処理されており分かりづらい
例.操作手順、操作結果、補足説明などの区別がつかず、探しづらい、など

解決策

この場合、操作手順、操作結果、補足説明や注意などの情報に応じて、それぞれのレイアウトを区別すると分かりやすくなります。これによりユーザーが、自分がすべきこと、確認すべきこと、必要にときに見ればよいこと、注意すべきことなどを判別しやすくなります。特に情報をグルーピングすることで、視認性がアップします。
また画面キャプチャ画像を適宜追加し、どの画面に対する操作なのか分かるようにして、視覚的な見やすさを向上させることもポイントになります。

マニュアル作成でよくある課題(5)
マニュアル担当者のリソースが足りず、
計画倒れになる

社内でマニュアル作成を実施しようとしたときに、直面するよくある課題についての解決策をご紹介します。

課題

マニュアル作成担当者のリソース不足
社内でマニュアル作成を実施しようとすると、よく立ちはだかるのがリソース不足です。ほとんどの企業が、マニュアル作成は実務との兼任になるでしょう。そのため、どうしても実務が優先されてしまい、マニュアル作成が進まないということも多いものです。とはいえ、無理して計画通りに進めても特定の社員に負荷がかかりすぎてしまいます。結局、計画倒れになってしまうケースもあります。

解決策

このような場合、マニュアル作成ツールや、マニュアル代行サービスといったアウトソースを使うのも一つの方法です。また、外部ライターとしてテクニカルライター、制作・翻訳ディレクターなどマニュアル作成のプロに常駐してもらい、マニュアル作成を実施してもらうという派遣を活用する方法もあります。

マニュアル作成でよくある課題(6)
Webサイトに掲載しているマニュアルが
散在している

最近では、Webサイトにマニュアルを掲載するケースは多いですが、その各マニュアルが散在しているケースについてもよくある落とし穴といえます。

課題

Webサイトに掲載しているマニュアルが散在しており、ユーザーが利用しにくい
例えば、Webサイトに掲載しているユーザーサポート用のマニュアルの形式が、html形式、PDF形式などで統一されておらず、ユーザービリティが損なわれているケースがあります。また、よくある質問ページ、ヘルプページなどにマニュアルが散らばっているため、見つけにくいといった課題もあります。

解決策

この課題についての解決手順は次の通りです。

1.すべてのマニュアルを収集する
2.目次案をつくり、情報を統廃合する
3.目次案が決定したら各マニュアルを参照し、原稿のリライトを進める

このときに、形式と掲載先ページを統一ことが欠かせません。ユーザーの使いやすさ、見やすさを重視するのがポイントです。

まとめ

このように、マニュアル作成は、大きな落とし穴が多く存在します。複数の課題が絡み合い、もはや更新の手間と労力に手がつけられない状態になることも決してめずらしくはありません。
マニュアル作成の手段は社内作成、外部制作、ツール活用など様々ありますが、マニュアルの本来の目的を再度捉え直し、中長期で見た際にコストメリットが大きい手段を選ぶことが重要と言えそうです。

他社のマニュアル作成事例を徹底紹介!導入企業事例集

「マニュアル作成」と一言で言っても、その内容もボリュームも対象者も企業によって様々です。
マニュアル作成を進めたいがボリュームが多すぎて何から手をつけていいか分からない、自社でやりたいことができるのか分からない、他社でどのようにマニュアル作成を進めているのか知りたい、 そのようなお悩みをお持ちの企業様は是非本事例集をダウンロードしてみてください。

 

 

【ご紹介企業様】

  • 三菱電機株式会社 さま
  • 三井住友海上火災保険株式会社 さま
  • 横河電機株式会社 さま
  • Yahoo! JAPAN さま
  • 第一三共ビジネスアソシエ株式会社 さま

など10社の事例をご紹介

ダウンロードはこちら

マニュアル制作・取扱説明書制作について詳しく知りたい方

東京:03-5321-3111 
名古屋:052-269-8016

受付時間 9:30~18:15

お問い合わせ・資料請求