”わかりやすい”マニュアル制作講座
◀戻る
第13回 【マニュアルの作り方】注意・参考・ヒント
マニュアルにはさまざまな要素が登場しますが、注意・参考・ヒントなど、本文を補足する要素の扱いは大切です。
補足要素の種類
注意を促す
「~しないでください。」「~は危険です。」など、注意を促す記述は、マニュアルではよく登場します。
通常は、マニュアル冒頭の「安全上のご注意」や「必ずお守りください」などのPL表記のページにまとめて記述しますが、本文中でも登場したり、重複して記述することもよくあります。
内容が「警告」なのか「注意」なのか「気を付ける」程度の内容なのか、しっかり識別して記述しユーザーにわかるように表記する必要があります。
別の道筋などを示す
メインの説明に対して、違う方法や似た方法で目的を達成する方法が存在する場合があります。
「通常はAを選びますが、Bを選んでもそこに到達できる」といような場合です。
こうした場合、AとBの説明を並列に説明するとユーザーは迷ってしまいます。
あくまでAをメインの説明として、Bを「参考」などとして記述すのが望ましいと言えます。
知っていると便利な知識
メインの操作に対して、TIPS的な操作や知識を「参考」や「ヒント」などとして提示します。
たとえば、ショートカットキーでの機能選択などは、メインの説明に加えるとユーザーが混乱する可能性があります。
こうした場合は別枠で説明します。
補足要素の提示のしかた
目立たせる
「警告」や「注意」などは、ユーザーに必ず守ってもらいたい内容なので、目立つようにレイアウトします。
赤枠で囲んだり、太いゴシック文字にするなど、ユーザーが読み飛ばさないような配慮をします。
目立たせない
参考情報やヒント情報は、知っていれば役に立つ情報に分類されます。
逆に言えば、知らなくても本筋の操作には支障がない内容です。
この場合は、メインの説明の流れを断ち切らないようなレイアウトを工夫します。
その上で、本文情報とは異なり「補足情報」であることがわかるように、薄い網を掛けたり、目立たない枠で囲ったりします。
種類はむやみに増やさない
1冊の中に「警告」「注意」「参考」「ヒント」「便利な使い方」「こんなときは」・・・といろいろな付加情報が出てくると読みにくいし、ユーザーはそれが何なのか識別できなくなる可能性があります。
種類は絞って内容、提示のしかたを一定に決めます。
ピクトを使う
ピクトグラム(小さなマーク)を使うことで、その付加情報が何かを示す方法が一般的に使われます。
誰にでもひと目でわかるピクトを用意してレイアウトします。
補足情報記述上の注意
簡潔な量にする
あくまで補足情報なので1ページ全体を使ったり、ページをまたがるような量の情報は避けます。
このような量になったときは、別途、項を立てるなど本文として暑かったほうがよいでしょう。
情報の切り出し方に注意する
参考的な内容なのに「注意」という枠に入っていたり、注意を要する内容なのに「ヒント」になっているケースを見かけます。
事前に、注意、参考にどんなレベルの情報を載せるかの基準を決めておきます。
とくに複数の人が原稿を書く場合は、しっかりした基準を作ってから原稿作成に取り掛かる必要があります。
株式会社 ワカール