プロが教える技術系マニュアル作成・5つのポイント

Tweet

Pocket

ここでは、プロのテクニカルライターが、技術系マニュアル作成時に押さえておかなければならないポイントについて解説します。

製品の取り扱い方や設計者向けの技術教育などで知っておいてもらいたい内容を文書化したものが技術系マニュアルです。こうしたマニュアルを使用すると、教育に関わる負荷や時間などを均一化し、効率化を促進することができます。

マニュアルも作成するにあたりルールやセオリーがあることをご存じでしょうか？
今回はマニュアルを作る上で、絶対に押さえておくべきポイントをご紹介します。

この記事をお読みいただくことで、これまでよりもさらに技術系マニュアルに理解が進み、読みやすいマニュアルの作成にお役立ていただけると思います。ぜひ参考にしてみてください。

１．技術系マニュアルは大きく二つに分類される

技術系マニュアルは、大きく2つにわけることができます。

一つは製品の取り扱い方を説明する取扱説明書などです。

もう一つは製品の保守点検、修理などで使用する分解マニュアルや整備マニュアルなど、特定の目的を達成するために使用されるサービスマニュアルや、専門職の方が使用する作業手順書などです。

わかりやすく説明すると、自動車の運転をするために、操作者（ドライバー）に用意されているものが取扱説明書、自動車の整備や修理をするサービスマンや保守点検者を対象に用意されているものがサービスマニュアルなのです。

２つの文書の大きな違いは使用される言語のレベルです。
取扱説明書は特に職種などを限定せず、一般的な人を対象に作成されているので平易な言葉、一般的にわかりやすい言葉を使いますが、サービスマニュアルは専門用語を使用しています。それが理解できていることを前提に作成を進めるからです。

２．作成前に確認しよう、押さえておきたいポイント

文章を書く時、誰に向けて何を書くのか、というのは重要なポイントとなってきます。技術系マニュアルも同じです。誰が何のために誰に向けて書くのかをしっかりと押さえておきましょう。

ポイント1．誰が読むのか？　まず読者を決めよう

取扱説明書なら機器やソフトの使用者が読者になります。サービスマニュアルや分解手順書などは保守点検を行う人が読者になりますね。

まずは誰が読むのかをきちんと想定しておく必要があります。
読者が決まると、想定する内容や用語のレベルも決まってきますし、文体などもおのずと決まってきます。

ポイント2．マニュアルの“目的”や“理由”を明記しよう

取扱説明書や手引書などの冒頭には、この書物の目的や作成された理由が記載されています。

「〇〇（機器の製品名）の取り扱いについて記載しています。」
「製品の修理手順について記載しています。」
「この章では〇〇するために製品を分解する手順について記載しています。」

読者に目的を明記するのはとても大切です。目的や理由を最初に説明すると、この取扱説明書において読者が今必要である情報なのかどうかがはっきりするからです。

一般的な読み物と違って、自分の目的とする操作や行動について記載がないと、いたずらに全部読まなくてはいけないという負担を読者に負わせることになります。

また、初めに宣言しておくと、この章や節に関してはそれ以上のことを書く必要がないため、効率よく作成が進みます。

ポイント3．マニュアル作成のスケジュールを決めよう

取扱説明書もサービスマニュアルも、リリース日は製品に連動している場合が多いです。作成依頼があった場合はまず製品のリリース日を確認して、いつまでに何をどのようにするのかを大枠でよいので把握しておく必要があります。
 

特に取扱説明書はインターネットでマニュアルを配布・表示する現代であっても、製品と同梱であることは自明の理。というのも取扱説明書は製品の部品の一部であり、欠かせないものだからです。印刷物で製品と同梱する場合は、取扱説明書を印刷したり納品したりの手間を考えないといけません。

ポイント4．マニュアルのフォーマット（最終提出形態）を決めよう

取扱説明書やサービスマニュアルの最終形態をどのようにするのか決める必要があります。

紙媒体であれば部数なども決めなくてはなりません。印刷部数の多少は金額や納期に影響します。
電子版は運用の仕方で最終形態が大きく変わってくることがあります。
紙媒体用に作成したものを電子版に転用するだけのこともあれば、電子版として別個に作成し、拡張機能などを駆使して情報量を多くすることもできます。

凝った作り方をすれば時間もそれだけかかるので、スケジュールを考えながらマニュアルのフォーマットを決めた方が良いでしょう。

ポイント5．視覚的にわかりやすいマニュアルを目指そう

取扱説明書もサービスマニュアルも、イラストや図は欠かせません。一般的に人は、五感による知覚のうち割合としておよそ80％の情報を視覚情報から得ていると言われています^(※1)。

また、マニュアル類は理解の深度を高めることを目的に言語よりもテクニカルイラストなどを多用しています。言語で物理的な現象を表現しようとすると、文字量が多くなってしまい、読む気をそぐ結果を招きかねません。

^(※1)『産業教育機器システム便覧』（教育機器編集委員会編　日科技連出版社　1972）P4「図1.2 五感による知覚の割合」参照。
 

取扱説明書の場合、文字量は紙面の6割程度に抑えること、見やすさを重視することが大切です。文字が大きいことも大切な要素となっています。
紙版の取扱説明書は、暗黙の了解でいろいろと制約が多いので、非常に煩わしいこともあります。ターゲットとする読者を考慮しながら、見やすさとは何かを別途検討する必要がありますね。

３．メーカー別・部署別のポイントも

以上、簡単ではありますが、技術系マニュアルを作成する際に絶対に押さえるべきポイントをご紹介しました。

この5つは最低限押さえておかねばならないポイントで、メーカーや部署によって、盛り込まなくてはならないポイントが別途存在する場合もあります。部署内で運用する作業マニュアルなどは、特にそうした社内文化を反映させなければならないこともありますので注意が必要です。

ここに記載したものは自社内でマニュアルを作成するときに役立つだけでなく、外部にマニュアル作成を依頼する時にも納期や価格の設定などの見極めに非常に役立つポイントです。ぜひ参考にしてください。

次回は、取扱説明書を作成する際の重要ポイントについて解説いたします。
 

（アイアール技術者教育研究所　M・I）
 

Tweet

Pocket