読んでもらえるマニュアルを作成するコツ-目次構成-
投稿日:2022年06月17日
カテゴリー:ライティング
投稿者:
Oma
製品の取扱説明書、業務マニュアルなど、
世の中には様々な「マニュアル」があふれています。
これらは、実際のところ専任ではない人が制作を担当することがかなり多いようです。
製品の設計や開発の担当者が本業務の傍らで作成したり、
部署替えなどで引き継ぎが必要になった際に慌てて作成したり…
本来の業務に圧迫されると、どうしても質にはこだわれず、
読んでもらいにくいマニュアルになってしまうことも。
本記事では、読んでもらえるマニュアルを作成するためのポイントのうち、
誰でも少し意識するだけで改善できる「目次構成」のコツについてご紹介いたします。
目次構成を整理するメリット
書き手側のメリット
執筆の指標があることで、まとまりのあるマニュアルを作成することができます。
情報を網羅するだけなら、製品の仕様書をまるごと移して文章を整え、
内容に合わせた項目名を作成すればよいのですが、
それでは「マニュアル」としてのまとまりは生まれにくいものです。
操作や安全情報などあらかじめ必要な項目を決めておくことで、
関連する情報がきちんと整理され、
書き手主体のマニュアルになってしまうことを避けることができます。
読み手側のメリット
目次構成を整備することで検索性が向上し、使いやすいマニュアルになります。
利用するユーザーの行動や思考に沿った構成に整えておくことで、
一目見てマニュアルの概要やフローを把握することができます。
「読みやすい構成」を考える
ひとまとまりの長い文書を作成するときのセオリーは、ずばり「始めに構成を考えること」です。
これはマニュアルだけに留まらず、論文やレポート、ブログや読書感想文(懐かしいですね)、企画書や提案書など、どんな文書にも共通して言える作り方です。
全体構成をあらかじめ整えておくことで、まとまりのある文書を作成することができます。
論文などでは、「起承転結」に即した構成が使われることが多いですよね。
はじめに概要を説明し(起)、内容を展開し(承)、別視点の考えなどを盛り込み(転)、結論を述べる(結)という王道の構成で、読み手に自分の意見を理解してもらいやすくなります。
ひるがえって、マニュアルの役割は、
・基本的な操作やお手入れの方法
・導入時のチュートリアル
・困ったときのレファレンス
に大別できます。
論文のように、読み手に意見を理解してもらうためではなく、
読み手が必要な情報を必要なときに引き出しやすくするための文書です。
文書を扱う主体が、書き手ではなく読み手にあるのがマニュアルです。
そのため、情報が網羅されていることも確かに大切ですが、
利用者にとって最適な、つまりユーザーフレンドリーな文書であることが、
良いマニュアルへの第一歩とも言えます。
読み手側を意識した構成とは
ここで重視したいのは、
ユーザーの行動や思考に沿っているかということです。
自分が何らかのマニュアルを手に取ったときのことを思い返してみてください。
「よく読み込めば必要なことは確かに書いてあるけど、読みにくい」
「自分が知りたい情報をうまく探せない、どこに書いてあるのか分かりにくい」
と思ったことはありませんか?
そういう場合、多くはマニュアルが書き手主体で構成されていたりします。
とはいえ、自分で客観的に良し悪しを判断するのはなかなか難しいものです。
そこで、簡単なチェックシートを作成してみました。
ぜひお手元の業務マニュアルや取扱説明書などをチェックしてみてください。
一つでも当てはまっている項目があったら、改善の余地があります。
目次構成チェックシート
☑ 項目がユーザーの行動順に並んでいない
☑ 項目の階層が深すぎる(4階層以上)
☑ 目次だけで数ページある
※マニュアルの分量や紙面サイズによります
☑ 機能名やモード名がそのまま項目名になっている
※名前で用途などが容易に想像できる場合はOK
☑ 「○○の使用手順」「○○の作業方法」のような項目がたくさんある
☑ 項目名が長すぎる(14字以上)
改善の重要ポイント
チェックシートの各項目は、裏を返せば改善方法です。
・項目をユーザーの行動順に合わせて整理する
・項目の階層を3つまでにおさめる
・目次に出す必要がある項目かどうかを見直す
・ユーザー視点の項目名にする
・冗長な熟語を用いて表現しない
・項目名を長くても13字程度におさめる
まずはこれらを意識して目次を整えてみましょう。
…… 基本的な使用方法について オートモードでの使用方法 マニュアルモードでの使用方法 設定画面表示について ○○の設定変更方法 ○○の設定変更方法 ○○機能について …… |
↓
…… 使用方法 おすすめの設定で運転する 個別に設定して運転する 設定画面の見かた ○○の設定を変更する ○○の設定を変更する …… |
目次などの見出しの付け方については、こちらの記事もぜひご覧ください。
以上はあくまで一例です。
説明の対象である製品やサービスによって、
あるいは想定されるユーザー層などによっても、色々なアプローチがあります。
また、目次構成はいわば「マニュアルの入り口」であって、
ここだけ整えればOK!ということでもありません。
中身もきちんと整備されてこそ、マニュアルは読みやすく、使いやすいものになります。
自分のところのマニュアルはどの程度整っているのか?
どれくらい改善の余地があるのか?
改善にはどれくらい時間がかかるか?
こういったお悩みは、本業務の傍らでマニュアルを作成する以上尽きることがありません。
その場合、マニュアル制作会社にまるごと依頼してしまうのもおすすめです。
一般的な制作会社と違い、マニュアルの作成に特化しているため、
原稿や素材を形にするだけでなく、
マニュアルとしての品質の見直しから任せてしまうことが可能です。
たとえば弊社では、
・マニュアル制作(企画や原稿作成から印刷まで)
・既存マニュアルの診断、改善提案 ※無料版あり
・マニュアルの更新、管理運用面のサポート
など、一括委託からマニュアル制作にまつわる部分的なサポートまで、
長年の実績とノウハウで、お客様に合わせた細やかなサービスを提供しています。
マニュアルの外注はハードルが高く感じられるものですが、
どうしても改善の時間と手間が避けずに困っている…というときは、
一度検討してみてはいかがでしょうか。
マニュアルの改善・外注についてはこちらの記事をご覧ください。