‘ドキュメンテーション’ タグのついている投稿

【わかりやすいマニュアルの作り方】第209回 ドキュメンテーションの技術

2013年12月13日 金曜日

こんにちは、だんだん寒くなってきましたね、年末が近づく分しかたが無いかもしれませんね。

さて、前回(第208回)、以下のように書きました。

>私は他社の制作した取扱説明書を貶めたい思っているのではありません。
>単純に取扱説明書の作り方をトレーニングしてるところが「ない」と説明しているだけなのです。

説明が抜けましたけれども、これは教育機関がないという意味ではありません。
「統一的なドキュメンテーションに関する技術体系が日本国内ではまだ成立していない」ということについて述べようと思ったのです。

言い換えれば「大学で教えているところがないじゃないか」ということです。
そして、「愛」がどこにあるかという話を…

■「文化系」か「理科系」か?

では、まず基本の基本の質問です。
このドキュメンテーションという技術は、一般的に言うところの、「文化系」にあたる技術なのでしょうか?
それとも「理科系」の技術でしょうか?

「ドキュメンテーションスキル」と、webで検索しても、まずIT系の技術がヒットします。
実際に、ものを作りその動作についての説明をする、このドキュメンテーションという作業は、そのものを設計した人、作った人が一番最初に行えるというのは間違いの無いところです。

そのためにこのスキルは技術系のスキルとして認識されているようです。

■説明のスキル

でも実際の所はどうでしょうか。

「説明のスキル」というのは、一般には営業のスキルだと考えられています。
まぁそんなところでしょう。あまりこういうことは書きたくないのですが、エンジニアをやっている理科系の人たちの中には「私は文章なんかを書くのは嫌いだからエンジニアをやっているんだ。」と言う人たちがいるのは間違いありません。
そういう人たちにとっては、文章をわかりやすく書くと言う作業自体が、そもそもめんどくさくてやりたくないことをなのです。
こういった理由で、エンジニアの書くドキュメントの質はなかなか改善されません。当然ですよね。文章を書くこと自体が好きではないからです。

■テクニカルな側面

ではもう一つ、文系の人間がライターとして始めて、テクニカルドキュメンテーションを手がけた場合高い品質のものができるでしょうか?

はいその通りです。こちらもあまり期待できません。
なぜでしょうか。これは困った話ではありますが、文系の人間はその製品のテクニカルな側面について、あまり「愛を持っていない」からなのです。
製品に対する愛が少ないために、製品に関するドキュメンテーションも愛が少なくなってしまい…その結果、あまり高い品質のものでは無くなってしまうと言う問題が発生するのです。

困った話です。

■その上に…

さらに、この上に「わかりやすい」という特性を付けるためには、デザインとして見やすいものである必要もあるのです。
そしてデザインに関しては、また、製品のテクニカルな側面・文章の技術ともことなる上、それを理解したうえでテキストを作成しないとわかりやすい説明というのは、できあがらないのです。

マニュアル制作というのは、「マルチな」技術を持った人間が向いているものです。
単独の技術を深く追求するタイプの人間が、エンジニアリング的な技術の追求や、美しい文章の制作といった方向だけに向かってしまった場合には、「取扱説明書」という形では良い結果が得られるわけではないのです。

もう一つ面倒なことを言うと、取扱説明書はメーカーとお客様の間をつなぐ数少ない文書です。そしてその結果として、「法律的」な側面も持たされていると言うことです。

■テクニカルドキュメンテーションのスキル

人に技術のことを伝える「テクニカルドキュメンテーション技術」、これは大学などでも、教えろ方の先生が、複数の技術に対して愛を持っていなければならないので、教えられる人は少ないと思います。

したがってテクニカルドキュメンテーション講座、すなわちマニュアルの原稿を作るための講座といった講座はあまり実施されているところが多くないと思われます。
では、どうやってクオリティを高めていけば良いのでしょうか。ここがポイントですね。
と、あとにネタをひいておきます。


【わかりやすいマニュアルの作り方】第194回取説取扱説明書はサポートに必要です

2013年4月9日 火曜日

さて、前回は「ユーザーサポートが必要だ」というコンセプトについて書きました。
老人や子供、組み立てが必要な説明などにはどんなにしてもユーザーサポートが必須である商品というものが存在します。
ユーザーサポートは、「商品の使い方」について説明するものです。
ですから、「この商品をどう使えばいいか」ということが説明できることが必要なわけです。これは、具体的な使い方だけではなくコンセプトといったことも含むということに、ご注意ください。

■コンセプトについて書く
コンセプトというのは商品の目的です。加熱の道具であるとしたら、それは暖房器具であるのか調理器具であるのか、といったことです。
取扱説明書を書いたことがない人から見ると、すごく馬鹿馬鹿しい事のように思われるかもしれません。
ではユーザーサポートの電話の担当者に、聞いてみてください。
「商品の目的がわかってないお客様からの変な電話ってどれくらいあります?」
驚くほどの比率で「変な電話」が含まれているということを教えてくれると思います。例えばキャンプ調理用のワンバーナーを、寒いからテントの中でちょっと暖房用に使うと言ったぐらいのことだったら、使い方として根本的に間違っているいうことは言うまでもなくわかるとしても、ものすごくよくありそうな話だとは思いませんか?
現代は、こんなバカバカしいことでも書いてないといけないと言われる残念な事態になっています。できれば書きたくないことではありますが、法律的にクレームをつけられる(「だって暖房用として使用していけないとは書いてなかった」など)可能性だってあるのです。
別に逃げ口上を書けと言っているわけではありません。当たり前のことでも、目的外使用を禁止するといった事は何かしら書いておかなければならないと言うように、なってきています。でも、禁止事項としてではなく、「この商品は何をするためのものか」というようにお客様に積極的に説明していく、という書き方をした方が良いと思われます。

■使う人のことを考えて書く
前回の終わりに書きましたが、「老人が使う場合」「子供が使う場合」あるいは「技術者が使う場合」といったときには全く異なった書き方をする必要があります。
もちろん、視力のことを考えて、字の大きさをコントロールするといった技術的な話もありますが、それ以上に読む人が、どういう文化的背景を持っているかといったことを考えて書く必要があるのです。
僕の知り合いに、化粧品会社に勤めている人がいます。彼女の説明する化粧水について、僕は説明を聞いてもまったく理解できませんでした。しかし、妻であればおそらく理解できたんだろうと思います。実際そんなに難しい説明して押していたようには聞こえなかったのですが、それでも自分には理解するための文化的背景というか基礎知識が足りなかったので全くわからなかったのです。
これと同じことが、どんな商品でも起こりえます。
そしてわからないとユーザーサポートに電話がかかってくるのです。さらに取扱説明書の内容が悪いと、お客様がその商品で何の操作をしているかといったことが説明できなくなってしまいます。そしてユーザーサポートの手間がさらにかかるようになってしまうのです。
例えば、コンピューターの技術者向けの製品であれば、簡潔に短い文章を使って自律的な説明で書いた方が理解されるでしょう。ただその製品はたとえ同じ製品であってもそのコンセプトが、一般消費者向けであれば全く違う内容で書くべきだということになるのです。
ここが違っていると、目的に全く合わない取扱説明書ができることになります。
ですから取扱説明書を作るときには、誰に向けてどんな商品を作るのかといった取材が必要になってくるのです商品の調査だけでは取扱説明書ができないと言うのはそういう事を指しているのです

今回はこの辺までにしようと思います。