解決策①

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

解決策②

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

解決策③

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

解決策①

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

解決策②

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

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

a.目次（メインの目次）

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

b.目的別目次

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

c.プラン別目次

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

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

解決策③

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

解決策①

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

解決策②

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

解決策

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

解決策

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

解決策

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

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

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