マニュアルをうまく書くには

 

「マニュアルをうまく書くには」なんて言うと、私がまるでマニュアルを書くのが

うまいみたいに聞こえますが、実際はどうなのか、定かではありません。

フリーなのに、仕事が途切れずに来るところを見ると、

まんざら捨てたものではないだろうと、実は密かに思っています。(笑)

ここでは、10年以上マニュアルを書き続けて、体得したことを一般論としてご紹介しましょう。

実際は、製品によって、また届いた資料の質によって、アプローチのしかたは様々です。

細かいノウハウを書いても意味がないので、どんなものにも通じる、

マニュアル作成の心構えとして読んでみてください。

これからテクニカルライターを目指す人へ、私からのプレゼントです。

ホームページに戻る

 まず、その製品に惚れてごらん

私は昔、開発技術者でした。

自分がこの世に生み出した製品は、回りの評判とは関係なく、

自分の子供と同じようにかわいくて、思い出深くて、大切なもの。

開発技術者をやっていたおかげで、この気持ちは痛いほど分かります。

まず、マニュアルを書く前に、仕様書を読みながら、

開発者と同じように、その製品をよく理解して、惚れてみてください。

こんなところがすごいんだ。あら、こんなこともできる。開発者は頑張ったんだね。

でも、ここはちょっと間違えやすいからマニュアルで補足してあげないとね、などなど。

そのうちに、どんな順序で書けばベストなのか、頭の中に目次として浮かんできます。

(ここいらへんは、天性のものもあるし、慣れもあるでしょう。)

あとは、惚れた感動を読者にうまく伝えるべく、正しい日本語で書いていきます。

不思議なもので、惚れた製品のマニュアルは、誰でもうまく書けます。

マニュアルの文章自体は、昔から無味乾燥なものですが、

構成、見せ方、ニュアンスや言葉の選び方、ユーザへの心遣いに差が出ます。

機能を書き忘れるなんていう、ポカミスもありません。

お気に入りのゲームソフトのマニュアルなら、

誰よりも、うまく書けそうな気がするでしょ?

ホームページに戻る

 子供に料理を教えるように書いてごらん

子供に料理を教えてみてわかったのは、まず、言葉が通じないこと。

「煮立ったら・・・」「煮立つってどういうこと?」

「溶き卵を入れて・・・」「溶き卵って何?」

「びっくり水を入れて・・・」「びっくり水って何?冷蔵庫にないよ。」

初めての言葉が出てきたら、必ず補足説明を入れること。

すべて入れているとキリがないけど、なるべく入れるように心がけること。

それから、当たり前のことだからといって、省略してはいけません。

「炒め物はかき混ぜ続けないと焦げるよ。」とか、

「火を付けたら、鍋から離れちゃダメ。」なんてことも忘れずに。(笑)

 

ホームページに戻る

 手順どおりに思い描いてごらん

マニュアルを書くときには、現物がそばにあるとは限りません。

今まで、そんなラッキーなことは、ほとんどありませんでした。

仕様書を読みながら、想像力を最大限に発揮して書くのが一般的です。

だから、自分が操作している様子を、必ず思い描いて操作手順を書いてください。

仕様書が間違っていて、何かが抜けていることがあります。

手順を思い描くと、何かもう1つアクションをしなければ、

次の操作に進めないはずだと、気が付くことがよくあります。

そんなときは、面倒がらずにメーカーの担当者に問い合わせましょう。

                         (つづく)

ホームページに戻る