業務マニュアルや手順書の作成において、中身の説明はもちろん「目次」もマニュアルの品質を決める重要なポイントです。実は目次には、ユーザーの疑問を解決する情報が記載されているか、業務フローや機器の操作手順が理解できるか、判断する大切な役割があります。
文字のスタイルや書式の統一も重要ですが、まずは目次構成から整理して作成することで、ユーザーにとって活用する価値があるマニュアルとなります。マニュアルの見出しの作り方とコツについて理解し、ぜひ実践してみてください。
INDEX
1.マニュアル作成における目次の役割とは?
各章にはどのような情報が記載されているのか、見ただけで把握できるような目次の作成を意識しましょう。そのようにすることでマニュアルが作成しやすくなるだけではなく、全体的にまとまりのある内容になります。
なぜなら、ユーザーが行う操作の順番と、操作ごとに抱きやすい疑問や問題を意識しながら目次を作成しているためです。また、情報の抜けや漏れが起きにくくなるでしょう。
2.マニュアルに目次を設けるメリット
目次を作成するコツについてお伝えする前に、全体の構成とユーザーの操作手順を考慮するメリットについて把握しましょう。
2-1.情報を検索しやすい
ユーザーが、目次から知りたい情報を探しやすくなります。通常私たちがインターネットで知りたい情報を検索する際、関連キーワードを打ち込んで検索結果のタイトルと各サイトの目次を見るでしょう。実際、初めにタイトルや目次 を確認して、自分が知りたい情報が掲載されていそうかを判断する人は少なくありません。
同様にマニュアルのタイトルに、対象のシステム名または機器名が記載されていれば、当マニュアルで疑問が解決できそうだと判断できます。またインターネットの検索結果に出てきたサイトをクリックし、上部に記載されている目次に注目した際に、「そうそう、これについて知りたかったんだ!」と分かれば、該当箇所を閲覧して疑問が解決できます。
同様にマニュアルも、目次にユーザーが知りたい情報とページ番号を記載すれば、疑問が解決できると判断できるだけでなく、どのページを参照すればよいかが早く正確にわかります。
2-2.マニュアルの全体像がわかりやすい
マニュアルの目次を見ただけで、初めてシステムや機器を取り扱う人でも、業務フローや業務ルールが把握しやすくなります。目次を作成する際、対象のシステムまたは機器におけるユーザーの操作手順が意識されていれば、実際の業務フローに沿った順番の目次が出来ます。
さらに各フローにて、遵守すべき業務ルールが記載されているため、初めて業務に携わる人でも、対象のシステムの取り扱い手順および業務の流れがつかみやすくなります。
3.マニュアルで目次を作成するときのポイント
全体像を把握しやすく検索性が高いマニュアルは、ユーザーから重宝されます。目次作成におけるポイントについて2点抑えましょう。
3-1.わかりやすい構成にする
の項目にどのような内容が含まれているか、ユーザーが全体像をイメージしやすい目次構成にします。具体的には、以下のポイントを留意した作成が望ましいでしょう。
・見出しは箇所書きで並べるのではなく、大見出しと小見出しに分ける
NG例:
大見出し1
大見出し2
大見出し3
OK例:
大見出し1
小見出し1ー1
小見出し1-2
大見出し2
小見出し2-1
小見出し2-2
・大見出しは時系列ごとに区切る
・小見出しは、大見出しの機能別ではなく目的別に設定する
NG例
エアコンが持つ機能とは
エアコンのボタン操作について
エアコンの人体センサーについて
OK例
エアコンでタイマーを設定する方法
エアコンで冷房・暖房の温度を設定する方法
エアコンの人体センサーをOFFにするには
3-2.作業順に沿った内容にする
初めてシステムや機器を取り扱う人が、目次を上から順番に読むだけで業務フローが理解できる事が望ましいでしょう。なぜなら業務全体の流れが把握できるだけでなく、今後課題や疑問が生じてマニュアルを参照する際、どのページを読めばよいか判断しやすいためです。
まずユーザーが行うと思われる操作やステップを洗い出し、大見出しと小見出しにわけます。さらに、分けた各見出しを操作手順または業務フローの順番に沿うよう並べます。見出しは、できるだけ1-1-1や2-1-1などの「小見出し」までにとどめましょう。小見出し以上に細分化すると、見た目や内容が複雑化し、目次構成がつかみづらくなります。そのため、少ない数の見出しで済むよう各作業をある程度まとめることが重要です。
4.マニュアルを効率的に作成できるおすすめのツール
マニュアル作成ツール「Dojo」がおすすめ
マニュアルの目次は、ユーザーにとって、検索性が高く構成全体が把握しやすいかどうかが決まる重要な部分です。そのため、作成する際は十分に時間をかけて検討したほうが良いでしょう。
しかし、ユーザーがいち早くシステムや機器を利用できるよう、マニュアル作成にかけられる時間はそれほど残されていないことがほとんどです。そこでマニュアルの自動作成ツールを利用して、優れた目次作成の時間を短縮させることをおすすめします。
特許出願中の自動マニュアル作成ツール「Dojo」なら、ソフトウェア を起動し実際に対象の機器やシステムを操作するだけで、操作画面のキャプチャが自動で保存され、マニュアルが作成できます。ユーザーが一目で記載された内容がわかるような目次も自動で作成でき、あとから自由に編集できます。
実際に導入した情報通信企業において、最大で96%ものマニュアル作成業務の負担軽減ができたという実績があります。 マニュアル作成業務における負担軽減について検討されている人は、ぜひ下記より資料をダウンロードしてみてください。
【マニュアル作成ツールのDojo資料ダウンロード】 はこちら。
4.マニュアル作成は目次が8割
マニュアル作成は「目次が8割」といっても過言ではありません。なぜならユーザーは、目次を見て、当マニュアルは自分の疑問を解決してくれるのか、迷わず業務が進められるかを判断するためです。
インターネットで検索したほうが早く正確に理解できると思われてしまえば、マニュアルを作成する意味がなくなってしまうでしょう。また業務マニュアルは、業務フローや新しくノウハウが形成された際も、内容の変更または改善が必要です。
そのため業務マニュアルは、常に更新する前提で、マニュアル作成担当者や責任者 を定めておきます。目次構成からじっくり考慮し、ユーザーに常に 活用してもらえるマニュアル作りを心がけましょう。