第8回　【マニュアルの構成】説明の構成

 

​

 

説明構成をパターン化する

 

マニュアルは、読み物やカタログなどとは異なります。

どちらかというと、辞書や百科事典のように、一定のパターンで説明が構成されます。

ユーザーは、使い方に応じて思い思いの箇所から読み始めることが多いので、どこから読んでもパターンが揃っているほうが、混乱を招くことが少なくなるのが理由です。

また、目的の情報を探すときにも、以前に読んだ箇所と同じパターンであれば、安心して探せる効果もあります。

 

説明構成の考え方

 

​

 

ひとつの項目内での説明をパーツに分けると、次のような要素があることがわかります。

 

見出し

その項目の内容を示すタイトルです。

また、項目内にさらに小見出しが出てくることもあります。

また、図や表に見出し（キャプション）を付けることもあります。

これらの見出しを、どういうルールで設定し、どう表記するかを決めておきます。

 

リード

通常、項目の先頭に来る短い文章で、その項目でどんなことを説明しているかを簡明に記します。

人は、事前に概要や全体像を知っている場合と知らない場合では、内容の理解や理解の進捗度に差が出てくるものです。

最初に「今から何をするのか」をユーザーに理解することを目的として記述します。

 

本文

実際の説明本体になります。

次のような構成ルールを決めておくと、統一の取れた説明ができます。

 

• 一文の長さ
• 段落を変えるタイミング
• 手順説明のフォーマット（連続する操作など）
• 箇条書きにする条件
• 表組みにする条件、書き方
• 図やイラストの入れ方、入れる場所
• 付加的な情報の処理方法

 

とくに、複数の人が原稿を書く場合や、社内にたくさんのマニュアルがある場合は、マニュアル作成のマニュアルを作って、こうしたルールを明記しておきます。

 

本文外情報

注意、参考、ヒント、応用など、その項目でのメインストリームの説明を補強するような情報はよく現れてきます。

事前に、注意、参考などのパートを用意し、どのような情報をこのパートに入れるかを決めておきます。

ルールを決めておかないと、参考情報なのに注意として表記されたりしてしまいます。

こうしたことが頻繁にあると、ユーザーは本当の「注意」を軽視して、結果的に事故を招くなどの不都合が発生することもあります。