マニュアルに何を求める？

投稿日:2008年01月10日作成者:yasunaka

少し前のブログで書いたように、crossnoteのマニュアルを準備中です。マニュアルを書いていて少し思ったことなのですが、皆さんはマニュアルに何を求めていますか？

思えば昔、OSのマニュアルなどは、1冊の厚さが結構あるような本が何十冊もセットになっていました。その当時、これを全部読む人はいるのだろうか？　とか、もし読まずに知らないことがいっぱいあった状態で、何かとんでもないことをしてしまったらどうしよう、などと今考えるとつまらないことを考えていました。

実際、誰からも読まれずに消えていったマニュアルも多かったと思います。

マニュアルって一杯あると、まずその中のどのマニュアルに目的のことが書いてあるのかを探し出すのに苦労します。これはマニュアルが電子化された今でもあまり状況は変わらないのではないでしょうか？

あともうひとつ、技術系のマニュアルを読んでいてよく腹立たしく思うこととして、使っている用語がチンプンカンプンだ、というのがあります。なんだかよくわからない用語がいっぱいちりばめられていて、それらの用語の定義や意味の説明もなしに、操作方法だけが書いているようなマニュアルを読むと破って捨てたくなります。

そこで、crossnoteのマニュアルの方針は、こうしました。

１．マニュアルは薄ければ薄いほど良い！

２．用語はきちんと説明しよう

1つ目は読みきれる量のマニュアルを用意しよう、ということです。些細なことが一杯詰まった、でも誰からも参照されないマニュアルではなく、とりあえず最低限のこと、知っておくべきことだけをまとめて書いたマニュアルを目指したいと思います。

2つ目は、操作を書くのが目的ではなく、背景の概念や意味を説明するようにしよう、ということです。マニュアルに求めるのは、操作方法ではなく、その意味を知りたいのではないかと。

どうでしょうか？　よろしければ皆さんのご意見といただければと思います。