よいマニュアルを作る8つのポイント(後半)

033_yoi_maunal2

前半から引き続き、「良いマニュアルを作る8つのポイント」後半をお送りします。前半ではどちらかというと全体構成に重きがおかれていました。後半では、具体的なテクニックを中心にお話したいと思います。

5. なぜそうするのか、理由を示す

「書き手にとっての常識は、読み手にとっての非常識」  僕もこの文章を書いていてちょっとドキッとしちゃいましたが  要するに「これはなんのための作業であるのか」「なぜこうした動作が必要になるのか」という陰に隠れた重要事項を補足しましょうということです。

ただ頭ごなしに「書いてあるとおりにすればいいんだ!」とするのではなく、きちんと理由を説明してあげること。そうすればより理解も深まりますし、書いた人間の持つノウハウがそのまま読み手に伝わっていきます。ここを疎かにしてしまうと、マニュアルが意図することの半分も伝えられないでしょう。理解を深めれば、そのぶん身につくスピードも向上します。よいことづくめですね。

6. 写真撮影のポイント

写真を撮影するときは、かならず「作業者目線」で撮影してください。作業しながら見たときに、場所の特定が容易になります。また、ポイントとなる箇所はググッと寄って、全体の中の位置を示すときは少し引いて、というように目的に応じてメリハリをつけることも必要です。

さらに、とくに重要な場所へハイライトしたい場合、写真に直接手描きしてしまうと効果的です。写真のなかの一部分について丸囲みしたり、ひっぱる方向を矢印で書くだけでも、直観的な理解の手助けになります。Windows標準の「ペイント」/Macintoshであれば「プレビュー」アプリでも、十分その機能を果たしてくれるでしょう。

分かりやすい一枚の写真は、千の言葉に勝ります。写真の上手い下手は関係ないのです。上記のポイントをおさえれば「わかりやすい写真」がすぐにでも撮影できることでしょう。

7. ビデオ撮影のポイント

連続した作業や、写真だけではわかりづらい動きを見せる場合にビデオを使用します。ビデオでいちばん気をつけなればならないポイントは「そのビデオ、長すぎじゃないですか」という点につきます。ビデオも文章とおなじで、簡潔さが重要です。長くとろうと思えば、いくらでも長く撮れちゃいますからね。

前半では「一文一動作」と書きましたが、ビデオの場合「一再生一動作」としてもよいぐらいでしょう。ビデオが長すぎると見る側は退屈してしまいます。撮影したい動作の所要時間にもよりますが、30秒でも長すぎる恐れがあります。

8. マニュアルを作成したらかならず読み返す

マニュアルができたら、じっくり読み返しましょう。手順が抜けている、誤字があった、もっとわかりやすい写真に変えたい…などいろいろ気づくはずです。パソコンで作業されることが多いでしょうから、誤変換には注意してください。「内蔵HDD」が、いつのまにか「内臓HDD」になってたりしますから。

おすすめは、声に出して読み上げることです。職場内で声が出しづらければ、口パクでもかまいません。目で追うだけではどうしても読み飛ばしが発生し、きちんとした校正をおこなうことができません。声に出すことで読み飛ばしをふせぎ、思わぬ誤字・誤用を見つけることができます。

また、本文にばかり気を取られてしまい、見出し・タイトルの校正を疎かにしてしまってはいけません。本文を修正していく作業のなかで、見出しとそぐわなくなってしまうことが往々にしてあります。全体を通し読みすることで、よりふさわしい見出しを思いつくことだってあります。本文のほうを「小さい校正」というなら、見出しやタイトルは「大きい校正」にあたります。小さい校正→大きい校正の順に見ていくとよいでしょう。

あとは細かいことですが、「(以下、○○と呼ぶ)」という表現には注意してください。定義した以降、1コも出てこなかったなんて冗談みたいですが「あるある」なのです。

最後に

後半はこれでおしまいです。前・後半をとおして難易度の高いこと/高度なセンスが要求されることはただの一つもなかったはずです。純粋にテクニックの問題であり、取り組む姿勢を変えればよいマニュアルはすぐにでも作れてしまうのです。明日といわず、今日すぐにでも、上記ポイントに留意してマニュアルを作ってみませんか?