マニュアル制作の落とし穴!質が落ちる2つの理由と改善策
投稿日:2020年06月23日
カテゴリー:レビュー
投稿者:
Oma
テクニカルライター2年目のOmaです。
「マニュアルを書く」
って、難しいですよね。
世の中には様々な形態の文書であふれていますが、
マニュアルって、かなり独特なコンテンツだと思うんです。
一口にマニュアルと言っても、
業務手順書や取扱説明書、使用説明書など様々。
私は主に取扱説明書の執筆を担当しています。
書くことが好きでこの仕事を始めた私ですが、
この1年、色々なポイントで苦戦してきました。
たとえば先日、とある調理器具の取扱説明書を書きました。
「よし、完璧だ!!」
なんて内心思いながら、DTPと校正をお願いしたところ…
「ここ、用語の表記ブレてません?」
「『〇〇』と『△△』は対応してませんよね?」
「使用後、どうやって中身を捨てるんですか?」
校正者から、ものの見事に鋭い指摘を受けてしまいました…。
表記を見直し、なんとか無事、原稿は完成。
これって何が原因なんでしょう?
自分なりに考えてみました。
①推敲が甘い
②製品への理解がありすぎる
①は分かりやすいですね。
「完璧だ」と思い込んでしまうと、間違いに気づきにくくなるものです。
とくに、PC上での執筆について回るのが変換ミス。
漢字/カタカナ/ひらがなのブレ、送り仮名や同音異義語…
推敲でしっかり拾いたいところです。
②は、「何がいけないの?」と思う方もいるかもしれません。
マニュアルや取説の執筆には、説明するモノへの深い理解が必須。
これが逆に落とし穴なのです。
自分にとって「当たり前」のことは、説明がおざなりになってしまいがち。
「この製品は、こうやって使うもの。見たら分かるでしょ」
それって、製品を初めて手に取るユーザーにも「当たり前」のことなんでしょうか?
エンドユーザーの視点を失わない、
これは本当に大切で、とても難しい。
知ってしまった知識を無いことにして考える、なんてできません。
じゃあどうするか。
第三者視点でチェックしてもらうのです。
私の例では、校正者がその役割を担ってくれています。
しかし、
・正確な校正、校閲ができる
・マニュアル、取扱説明書の校正に熟練している
・ユーザー視点で(製品知識がない前提で)チェックできる
これらの要件をすべて満たす人が、自社内にいない場合もあるでしょう。
そんなときは、その道のプロに頼ってみるのも一つの手です。
この機会に、まずは既存のマニュアルを見直してみてはいかがでしょうか。
ちなみに、
文書内の用語や表記の誤りをチェックしてくれるソフトがあるのはご存知ですか?
「表記ルールに沿った文章にしたい」
「何十ページもチェックするのは、単純だけど時間がかかる…」
推敲の面倒くささ、効率の悪さにお悩みの方、ぜひこちらの資料もご覧ください。