コンテンツにスキップ

【わかりやすいマニュアルの作り方】 第24回 準備の詳細は? その1

24回目です。
今回から「目」レベルの詳細に入っていきます。

・準備
使用前の準備です。
機械の場合は「各部の名称」と「設置」、ソフトウェアの場合は「インストール」がこれにあたります。
また、たとえばファックス複合機のようにそれ単体で使え、かつパソコンで使える場合は両方が含まれます。

では、準備に含まれる項目の内容を見ていきましょう。
最初は「各部の名称」から始めます。

●各部の名称

ハードウェアの場合は、まずこの項目が最初です。
これは「どれもこうなっているから」という理由で最初にあるわけではありません。
最初にあるのは「本マニュアルにおける用語の定義」に必要だからです。
たとえば、四角くて電源しかないキョウ体のデバイスがあるとします。これについて書く場合はまず「前面」はどちらかから書くことになります。そうしないと、ユーザーはおろか書き手も混乱してしまうからです。
また、電源操作のボタンが2つ以上ある場合(片方は主電源で、もう片方はスタンバイ動作だったり電波の発信をとめるボタンのことがある)それぞれのボタンを明らかにわかるように名前を付けます。
エンジニアさんからの資料では片方は「電源ボタン」「パワーボタン」などとなっている場合があります。
そうした場合、片方は「主電源ボタン」とし、もう片方は「スタンバイボタン」や「電波スイッチボタン」などとユーザーさんの使う状況を考えてまぎらわしくないようにして、メーカーさんに「これでよいか」と確認して名前を付けます。

続きます。

コメントを残す

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