技術者がマニュアルを書くとリファレンスマニュアルになってしまう

マニュアルバイブルから学んだこと
技術者がマニュアルを書くとリファレンスマニュアルになってしまう

啓学出版(今は存在していない)発行のマニュアルバイブル(絶版)という本があります。
この本から学んだことの一部をここに紹介していこうと思います。

自分史を書くということは、長い文章を作成することです。
うまい文章やわかりやすい文章は、文才に恵まれた人だけの特権だと思っていませんか?
もちろん文才に恵まれた人は、うまい文章やわかりやすい文章を書くことができます。
でも、特に文才がなくたって、十分にうまい文章やわかりやすい文章を書くことはできるんです。
ここでは、そのちょっとしたコツを1つずつ紹介していきます。

技術者がマニュアルを書くときだけでなく、査読を依頼するとそのチェック結果も、これに似たようなことが起こります。
用語や事象を説明することに関心がいき、マニュアル全体の構成に支障が出るような修正を求めてくるのです。

これが新人テクニカルライターと組んだら、そのまま支障あるマニュアルが世に出てしまいます。
そして、その新人テクニカルライターは、マニュアルとはそのようなモノだと思い込んでやがてベテランテクニカルライターになってしまうのです。

日本のテクニカルライティングの初期は、そんなライターさんがほとんどでした。
「正しい」記述にだけ思いを寄せて、それがどのくらいお客さんに伝わるのかを配慮できない人が。
あるいは、お客さんは熱意を持ってマニュアルを読むとの前提に立つとか。

一見正論(記述を正しく!)であるように思えるだけに困ったモノなのです。


チョイ上の自分史 わたし本 を作ろう!

コメントを残す

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