コンテンツにスキップ

【わかりやすいマニュアルの作り方】第89回 取材について01

ここのところ、堅い話が続いて(僕も)困っているので、今回は実際の制作の話にして、気楽に書ける内容にしようと思います。
さて。

●マニュアル作りの第一歩は仕様書から

マニュアル作りは、仕様書をまずだーっと読むところから始めます。
だーっと、です。詳細に検討するのはあとで。
もちろん、仕様書なんかなくて現物しかない場合もありますが、それもまた別の話。
だーっと読んでいくと、大概は仕様のなかに妙にひっかかる、まわりくどい部分があります。
もしも読んでいてそれにひっかからないとしたら、それはバージョンアップや改良でこなれた製品であるか、あるいは見ている方が技術的センスに欠けるかです。もちろん、何度もブラッシュアップされた製品でしたら、それにこしたことはないのですが。

●仕様に問題がある?

通常、販売する以上は、仕様には致命的な問題はなくなっています。
ひっかかるようなところといっても、通常はトラブルにまではいたらず、せいぜいがところ取り回しでちょっと不便に感じたり、一時的にシステムが遅くなったりといった程度のことです。
しかし。
ここはマニュアル制作者としてはひっかかってみないといけません。
「なぜこんなに仕様になっているか」疑問を持つべきなのです。
実機があれば実際にやってみる。仕様書ではわからないようなケーブルの取り回しがあって回避されているかもしれない。速度低下も回避方法があるかもしれない。
やってみたら、エンジニアさんにインタビューする。
エンジニアさんは、もしかしたら「しまった」という顔をするかもしれません。もしかしたら、気がついていない…ということはあまりないと思いますが…かもしれません。
そうやって、「どうすればよいか」とか「どういうときに使う想定なのか」を聞いたら、マニュアルの企画に取り込みます。
どこにどうやって書くか、を考えるのが、取説制作者の役割です。

コメントを残す

メールアドレスが公開されることはありません。 が付いている欄は必須項目です