マニュアルの分冊と目次構成

マニュアルの分冊と目次構成

制作側の都合としてはマニュアルは分冊しないほうが作業は楽だが、読者側からすれば自分の使う箇所だけ抜粋した（分冊した）マニュアルがあったほうが便利でわかりやすい。

また、一度だけマニュアルを見て操作する説明と常にマニュアルを見て操作する説明が一緒に記載されている必要はない。1冊300ページ以上になるマニュアルは、記載項目を詰め込み過ぎて使いづらく、検索性も悪くなる。

こうしたケースに当てはまる場合は、マニュアルの分冊をお勧めする。分冊する際は、マニュアルの対象読者はだれなのか、また使用頻度や状況はどうなっているのかを確認すれば分冊方法が見えてくる。

【事例１】使用する機能や操作が使用者によって異なる

同じ製品でも、使用する機能や操作が使用者によって異なる場合は、まず製品の使用者を確認し、使用状況と使用機能を洗い出す。その上で、使用者に合わせて分冊するかどうかを検討する。

例えば、使用者が「管理者」「日常業務の作業者」「メンテナンス作業者」に分かれる場合は、１冊のマニュアルですべてを説明していれば、各使用者にとって不要な説明が多くなる。

「管理者」は、他の使用者に閲覧や操作されてはいけない機能が多いので、使用者共通のマニュアルとは別に『システム管理編』などの別冊にすべきだ。
また、「日常業務の作業者」は、作業内容が限定されるのですべての機能を知る必要もない。日常業務に必要な作業や機能を『日常業務編』などの別冊にすれば、担当者が変わるときにトレーニング用マニュアルとしても使用できる。
「メンテナンス作業者」に至っては、修理や点検が目的なので、通常の機能や操作の説明は不要になる。点検方法や修理方法を『メンテナンス編』などの別冊にすれば、事足りるだろう。

このように、使用者が必要とする機能や操作を確認することで、分冊の方向性は見えてくる。

購入後の使用準備として、製品を組み立てる説明や、セットアップのためのインストール操作などは、購入直後しか必要にならない。

そのため、常に説明を確認するマニュアルとは分け、別シートや別冊子で制作したり、製品によってはパッケージに記載するのもよいだろう。

開発者や専門家を対象にした製品の場合、余分なマニュアルはかえって邪魔になる場合がある。基本はすべて同じパターンで書かれ、検索性に優れたリファレンスがあれば十分事足りるはずである。

ただし、記載内容が多くページ数も多い場合や、専門家ごとに見る箇所が異なる場合は、『XX仕様編』『コマンド一覧』『エラー一覧』など、別冊にすると便利である。

サービスマンがマニュアルを必要とするのは、納品時のセットアップや点検、修理など、目的は明確なので、その状況に合わせて分冊を構成していけば問題ない。

納品時の設置には梱包の状態や付属品が確認でき、設置手順が明記された『設置マニュアル』。メンテナンス・点検用には定期的な点検方法が明記された『メンテナンスマニュアル』。トラブルや修理用には、エラー内容の一覧や修理方法が記載された『トラブル対応マニュアル』『エラー一覧』『交換部品一覧』などが分冊されていれば便利である。

一般ユーザー向けの製品といっても、使用状況や使用目的によりユーザー層は分かれる。
そのため、ユーザー層をつかみ、分冊構成を考えるときには以下の内容を確認してほしい。

パソコンの認識度：パソコンの認識度は、製品を使用するうえで、どこまでパソコンの操作が必要になるのか、どのレベルまでパソコンの知識が必要になるのかを確認することだ。
そのうえで、どのレベルまで説明すれば理解してもらえるのかを考え、『入門ガイド』や『初級者編』などの別冊を検討する必要がある。

ソフトの知識：ソフトのパッケージ製品は、ソフトの認識レベルに合わせて製品が用意されている場合が多いので、購入時点で対象ユーザー別の製品＆マニュアルが制作されている。例えば、データベースや会計ソフトなどは、家庭向けに家計簿用ソフトや住所管理用ソフトが親切丁寧なマニュアル付きで販売されている。一方会社向けには、会社の経費や確定申告にも使用できる会計ソフトや、顧客管理にも使用できるデータベースソフトが用意されている。このように、パッケージソフトは、対象ユーザーが明確になっているので、そのユーザーレベルに合わせて分冊を構成する必要がある。

製品の使用目的：プリンターやデジカメなどは、ユーザー層が広く、何の目的で購入し、どの程度、どの機能を使用するのか、判断が難しい製品だ。プリンターなら文書印刷から展示会用の写真印刷まで目的が異なる。そのため、初心者を対象にした説明からセミプロを対象にした説明まで、性能や価格帯でユーザー層を想定し、分冊方法を検討する必要がある。

例えば、プリンターは一般ユーザーだけでなく、セミプロのカメラマンも対象となるため、一般の印刷機能の説明だけでは物足りなさを感じる場合が多い。
印刷した写真を展覧会に出品するユーザーにとって、写真の画像処理や印刷方法は、通常の印刷機能とは別に詳細な説明が必要となる。そこで、撮影写真の画像処理方法、画像データを最大限に引き出す印刷方法に特化したマニュアルを制作することで、製品を選別・購入するきっかけとなる場合もある。

分冊構成を考えたら次は目次構成の検討である。

まず、記載すべき項目をリストアップし、記載内容を分類する。分類することで、どのマニュアルに記載するのか、構成（目次）を決めていくことができる。 一般ユーザーを対象としたマニュアルを例にすれば、説明すべき内容として以下の項目がリストアップされる。構成内容はハード機器とソフト製品で異なってくる。

①購入直後に必要となる準備操作
　⇒『セットアップマニュアル』
・購入時の梱包と付属品の確認
・使用するための設置準備

②本書の見かた
　⇒分冊マニュアルも含め、すべてに記載
・取扱説明書の構成と使いかた／本書の読みかた（アイコンや記号の説明含む）

③注意事項
　⇒『基本操作ガイド』または別冊『安全ガイド』
・PL法に基づく取り扱い上の注意（危険、警告、注意などの項目を含む）
・その他の使用上の注意
　※法規制等は国によって異なるので、翻訳するなら別冊『安全ガイド』等での対応がおすすめ。

④各部の名称
　⇒『基本操作ガイド』『リファレンスガイド』

⑤基本的な操作
　⇒『基本操作ガイド』
・電源のON／OFF
・基本操作（電源ON後、機器を使用する初期状態について説明）

⑥機能説明
⇒『基本操作ガイド』『リファレンスガイド』
・実行できる機能（機器から実行できる機能について説明）
・メニューから実行できる機能（メニュー項目ごとに説明）

⑦お手入れ／メンテナンス 
　⇒『基本操作ガイド』『リファレンスガイド』『メンテナンスガイド』『トラブル対応ガイド』
・定期的なメンテナンス（定期的に確認すべきメンテナンスの説明）
・機器の状態を確認する（確認方法と状態ごとの対処方法を明記）

⑧消耗品の交換とオプション品
⇒『基本操作ガイド』『リファレンスガイド』
・消耗品の紹介／オプション品の紹介

⑨エラー表示と対処方法
　 ⇒『基本操作ガイド』『リファレンスガイド』『メンテナンスガイド』『トラブル対応ガイド』
・エラーが発生している（モニターやランプ表示など機器のエラー表示を明示）
・その他のエラー（起動できないなど、エラー表示できない状態への対処方法）
・改善できない場合の連絡先

⑩仕様一覧
　⇒『基本操作ガイド』『リファレンスガイド』
・本体仕様
・使用環境／保管環境

ソフトウェアの場合：

①購入直後に必要となる準備操作
　⇒『セットアップマニュアル』
・購入時の梱包と付属品の確認
・インストール環境の確認
・アプリケーションソフトのインストール

②本書の見かた
　⇒分冊マニュアルも含めてすべてに記載
・取扱説明書の構成と使いかた／本書の読みかた

③注意事項
　⇒『基本操作ガイド』『リファレンスガイド』

④基本操作
　 ⇒『基本操作ガイド』
・ソフトウェアを開始する／終了する
・開始画面について（初期画面について説明）
・ソフトウェアでできること（メニューごとにその機能概要を説明）

⑤機能説明
　⇒『基本操作ガイド』『リファレンスガイド』
・メニューから実行できる機能（メニュー項目ごとに説明）

⑥エラー表示と対処方法
　⇒『基本操作ガイド』『リファレンスガイド』
・エラーメッセージが表示される
・その他のエラー（起動できないなど、エラー表示できない状態への対処方法）
・改善できない場合の連絡先

⑦仕様一覧
　⇒『基本操作ガイド』『リファレンスガイド』

今回紹介した分冊や目次構成の考え方は、あくまでも一般的な事例をまとめたものである。
もちろん、マニュアルを制作する製品により、対象となるユーザーも考え方も異なってくる。

---

---