人のことをいえん

某社で取り扱っているサーバ構築の面倒をみていた関係で、それらを再構築するためのドキュメントを書くことになりました。まぁ、よくあることです。何度もレビューを行って、4回目のリテイクに突入しました。

「マニュアルは分からない人にも分かるように！」

というのがモットーなんですが、やっぱり第三者の目を通過すると、自分の中で当たり前のことが盲点になって、その結果として「この書き方じゃ、そこまでは想像できない。」という反応を目の当たりにしたりするわけです。

ダメじゃんか・・・自分だって。

こういうのは、さじ加減が難しいですね。つい、自分が知っていることは前提として書き飛ばしてしまいがち。かといって、ひとつひとつを丁寧に検証していくと、さっぱり進まなかったりとか。技術系のドキュメントは難しいんですよね。

そういやこないだ、若手芸人の漫談であったなぁ。携帯電話の説明書が分厚すぎるって。

==========
●説明書の「故障かなと思ったら」ページがバカすぎ！

「相手の声が聞こえません」
　→「受話器を耳にあてていますか？」
　　→「携帯電話の使い方くらい分かるわ。バカにすんな！」

＃同感なんですけど、これ、フールプルーフってヤツなんですね。ドキュメントとして必要と言えば必要なんだろうけど、ほとんどの人には不要なんですよね。でも、仕様書畑の人は書かないと落ち着かない・・・と。

●「説明書」に説明書をつけるな！

「説明書の読み方」というガイドブックがある。
　→「こんなものをつけるから余計に分厚くなるだろうが！」

＃フールプルーフ対策で、膨れ上がったマニュアルを読みやすくしようとしたら、かえって裏目にでたって感じでしょうか。マニュアルを作る立場も読む立場も、分厚いマニュアルなんて嫌いなのに、結果的にそういうことになっちゃうんですよねえ。
==========

若手芸人の意見にはかなり同意するけど、作る立場だって苦労しているんだろうなぁ・・・と、思わずにはいられません。あのボリュームのマニュアルを作るのって苦行に近いと思いますもん。たぶん、社内で何度もイヤってほどレビューして、夢に見るくらいに作業したんだろうなあとか。

「故障かなと思ったら」に書くバカっぽい内容だって、いざ、分からない人がクレームを投げてきたら、「シロウトに優しくない」とか「老人を情報弱者にするつもりか」とか、けちょんけちょんに叩かれるんだから・・・ねえ。それを考えると、やっぱり、メーカーとしては「バカだなー」と思うことも書くんだろうなと。

なんにしても、人に何かを伝えるというのは難しいものです。特に知識レベルが想定できない対象に適切な説明を印刷物で行うのは難しいでしょう。たぶん、込み入った製品に対する説明をするなら、オンラインマニュアルがもっとも適しているんでしょうね。

それならレベルに応じて動的に見せる範囲を絞り込むことも可能です。マニュアルデータの総量としてはものすごい量になると思いますが、ビジュアルで分厚い説明書っぽく見せずにすみます。

ただ、まぁ、そうしても、結局「オンラインサイトを見られない人には不公平だ」ということになるんでしょう。もちろん技術側も、そういった層にあの手この手でアプローチすることも大事です。でも、一定水準以上の話については、各自、苦労してもらえばいいんだと思います。

サポート関連のメールを参照できる立場にいるんですが、初心者にはひどい内容が多い気がします。「CGIの使い方を分かりやすく教えるべきだ！」「HTMLの書き方の基礎を教えてほしい。」・・・などなど。

たいていこういうのは独学で学ぶべきものだし、そうでなければお金を払って然るべき教室に行けばいいんですよ。ほとんどの技術屋さんにしたって、CGIやらHTMLやらってのは、誰かに教えてもらったわけじゃないと思いますよ。分からないところは時間をかけてがんばって習得しているはずです。

さらにはCGIにしても、不正な情報の入出力には注意を払うべきところがたくさんあります。そこを「初心者だから敷居を低くしろ」なんて言われてもできない相談なんですよ。アメリカに到着した日本人が、「オレは日本語しか分からないから、みんな日本語を勉強してくれ！」というほどムチャです。

マニュアルを書く方も読む方も学ぶべきことは多そうです。