コンテンツにスキップ

【わかりやすいマニュアルの作り方】 第60回 マニュアルの形 その05

続きです。

■目的から形を考える

マニュアルはどういう時に必要かということから形を考えます。
マニュアルが必要なのは

  1. 何かをやろうとしてできなくて困っているとき
  2. 決まった手順を守る必要があるとき

くらいでしょうか。

(2)の典型例が設置やセットアップ、インストールです。もっとも「書いてあるとおりにやったはずなのに手順通りに進まない」ことが起こって(2)から(1)へ移行してしまうということもよくありますが。

ということは、これら2つのマニュアルは形からして異なるべきです。

◆「何かをやろうとしてできなくて困っているとき」の形

(1)は困ったときに手元にある必要があります。映画「3丁目の夕日」のお守りのように、すぐに使えなければ意味がありません。

そのため、設置する機器にぶら下げたり、画面で常にヘルプを表示するようにしたり、防水にしたり、判型を小さく、軽くして持ち運びに配慮したりする必要があります。

また、困ったときに調べるものですから、検索性はとても重要です。

「読んでわかる」目次と索引、できれば章ごとの耳(辞書のページ端にある「ABC…」「あかさたな」の黒い帯)も付けたいところです。そして、必要以外のものはできるだけない方がよいです。必要ないものがあると検索性を損ない、携帯性も落とすからです。

◆「決まった手順を守る必要があるとき」の形

さて、それに対して(2)です。
こちらは基本的に困っていない時に使うものです。ですから、多少いろいろなことが書いてあってもかまいませんし、むしろ書かなければいけない内容はこちらに書く方法もあります。

たとえば「お買い上げありがとうございます…」という挨拶、PL法関連の記載、著作権表記、法律上必要な記載事項など。

これらは、「手順」を書いたほうのマニュアルにおくべきで、困ったときに開く「虎の巻」のマニュアルには書くべきではありません。

なぜなら(2)は、持ち歩く必要がなく、多少余分なことが書いてあっても、さしつえがないからです。

こういうことを書くと「本来そういうことではないだろう」とおしかりを受けるかもしれませんが、PL法に対応して「まとめて書かれた」注意や、法律関連の記載事項はほとんど読まれないか、良くて一度目を通す程度なのですから。

もうちょっと続きます。

コメントを残す

メールアドレスが公開されることはありません。 が付いている欄は必須項目です