【わかりやすいマニュアルの作り方】第9回 構造の作り方はどうする?

第9回です。構造の作り方の続きです。

マニュアルの使いやすさとは

マニュアルの使いやすさとは、検索のしやすさと、探しているものにすぐにたどり着けるかです。
たとえば、OSの説明書でLANを組もうとした場合のユーザーの行動を考えてみます。

LANならば、普通はネットワークや通信設定関連の項目を探して読みます。

しかし、操作に囚われたマニュアルの作り方をして、コントロールパネルの項目にしか記載がなかったら、ユーザーはたぶん目的の項目を探し出すことができず、取扱説明書はせいぜい枕か重石、あるいは焚き付けに使われるのが関の山でしょう。

つまり、ユーザーの視点から見て、対象のものやソフトウェアの仕様書を再構成してやる必要があるのです。
ですから、1つの設定項目では設定が完了しない場合は、複数の手順を1つの項目としてまとめたり、コラムなどで別の部分の設定が必要と注記する必要が出てくるわけです。

見出しは各機能の手順のまとまりのレベルまで分解します。手順が複数の機能を使っている場合でも、目次構成の段階では気にする必要はありません。
また、同じ機能を複数の箇所に記載する場合は、それがよほど大きなボリュームのものでかつページに制限がある場合などを除き、それぞれの操作手順に記載した方がわかりやすいでしょう。
最終的にそれぞれの手順まで分解したら、それをツリー状に配置します。上に述べたように「機能」にまで分解する必要はありません。
このあたりのことは、別の回に予定している「仕様書の読み方」で説明します。

続きます


タグ: , , , ,

コメントをどうぞ