マニュアルの役割など原稿を書く前に知っておくべきこと

マニュアルの役割など原稿を書く前に知っておくべきことを紹介します。

わかりやすいマニュアル作ると、どんな効果があるでしょうか？

短い文章で書き、誤解を招かない表現で、正しい情報が書かれていれば、
使用者は正しく製品を使うことができます。
安全に製品を使うことができます。

必要なことが不足、間違った情報、わかりずらいと、
製品が壊れたり、使用者が怪我をする心配があります。

１. マニュアルは製品の一部

製品がどんなに素晴らしくても、マニュアルがわかりずらいと、
製品そのものが良くないと思われる危険があります。
製品イメージや企業イメージを大きく傷つけてしまうかもしれません。

この経済効果は大きいですね。 

あるメーカーの社長がお客様を訪問した際、

「貴社の製品は素晴らしい、でもマニュアルがわかりにくので、うまく使えない」

という声を聞きました。

これは製品イメージに大打撃であり、

すぐにマニュアルを見直すように大号令をかけたそうです。

技術者のためのテクニカルライティング入門講座【電子書籍】[ 高橋慈子 ]

専門書籍を勉強することも大切ですが、
上達するコツを理解してから読むと効果的です。
この記事は、長年の経験から抽出した、A4用紙で30枚程度です。

2. お客様からの問い合わせや苦情への対応

もしマニュアルに正しく書かれていれば防げた事柄はありませんか？

お客様からの問い合わせに対応している時間は、生産に寄与しません。

その時間を生産に充てることができれば、、、、、

大きな機会損失です。

産業機械などの製品は高額です。

また生産財ですので購入された製品が停止すれば、お客様は多くの損失がでます。
ですから迅速な対応が欠かせません。
サービスマンが訪問すると、操作が間違っていただけで修理は不要でした。
こんな時にお客様から「マニュアルがわかりにくくて分からなかった」
と言われるとサービス費用（交通費などもあり、通常は数万円以上です）は請求できなくなることもあります。
大損害です。 

3.昔のトラブル（パソコンのマニュアル）

今から40年ほど前、パソコンが急速に普及したとき、
技術者がマニュアルを書いていました。
そのため、専門用語の羅列で読者は何をどうしたらよいかわからず、
メーカーへの問い合わせ電話がものすごい数になりました。
対応が悪ければお客様は離れてしまいます。
メーカーは人員を増やすなど、その対応に苦慮しました。

このようなことが起きていないか、ぜひ確認してみてください！

4.企画構成

4.1　企画構成の手順

実際に原稿を書く前に、企画構成案をまとめます。
それに基づいてテクニカルラティングに着手します。
多数の書籍が出版されていますので、参考にしてください。
ここでは簡単に触れます。

1.製品の情報を収集します。
・開発コンセプト
・製品の位置づけ
・機能、性能、仕様
・使用目的と予見できる誤使用
・安全性
・操作性
・ターゲットユーザー

2.製品を分析します。
・製品背景の分析
・製品特徴の分析
・導入作業の分析
・製品機能の分析
・操作性・作業性の分析
・活用性の分析（オプションや他製品との組み合わせでの使用など）

3.ユーザー（使用者）を分析します。
・製品を使用するために必要な知識、経験、環境、資格
・使用目的と予見できる誤使用

　ユーザー（使用者）の安全が一番、この分析が重要です。

4.記載しなければならない情報を洗い出します。
・設置、操作、保守、トラブルシューティングの詳細項目
　そしてインスラクション項目とリファレンス項目に分けます。

　※インストラクションマニュアル
　　入門マニュアルとかチュートリアルマニュアルと言われるマニュアルです。
　　知識のない方や知識の少ない方など初心者が対象です。

　※リファレンスマニュアル
　　機能別マニュアル、目的別マニュアルと言われるマニュアルです。
　　個々の機能や作業内容を掘り下げて説明します。
　　すでにある程度の知識を持っている方が対象です

5.目次構成（ストーリー）を決めます。
・章、節、項
・分冊
・インストラクション/リファレンス
・操作担当者と保守担当者

6.表現設計を決めます。
・レイアウト
・情報を区分と表記ルール
　注意に関する情報、説明情報、操作手順の情報などに分けれます。
　それぞれの文体（ですます調など）、記号、書体などを決めます。
　いわるる「型」を決めます。
　注意事項（危険、警告、注意）、手順、結果、説明、補足、参照など
・図版（イラストや図）ルール

シンプルが一番

4.2　目次例

＜消費生活用製品（民生品）＞
・表紙
・重要事項説明
・商品説明
・各部の名称
・安全上のご注意（危険、警告、注意）
・使用方法（組立方法、取付方法）
・お手入れの仕方
・故障かなと思ったら
・修理の窓口
・保障規定
・製品仕様
・責任主体表示

 ＜工業用製品（産業機械の例）＞

 ・表紙
・はじめに
・機械の使用目的
・作業資格について
・機械の廃棄に関して
・仕様銘板位置について
・安全作業を行うために
1.　安全に関する注意事項
2.　据付
3.　操作
4.　保守

4.3　目次とタイトル

目次は、必要な情報を探すために欠かせません。

自分が読みたい情報がどのにあるか探すとき、読者は目次を見ます。

 どんな情報なのかがわからないタイトルはダメです。

・点検１
・点検２
・点検３

何なのかわかりません。

・主電源を投入する前に点検すること
・主電源を投入してから点検すること
・操作電源を投入してから点検すること

であればわかります。

読者が知らない言葉はダメです。
コンパイル、リダイレクト、インターラプト、リワインド

知らない人には何のことかわかりません。

読者は自分の頭にあるキーワード、製品の機能名称で探します。
注意しなければならないのは、読者が知っている言葉（既有知識）です。
それはマニュアルの種類によっても変わります。
既有知識を意識して目次タイトルを付けてください。

すでにベースになるマニュアルがあると思いますが、
上記の視点で見て、不具合があれば直してください。