ヘルプといっても最近は沢山な種類があります。 一番ポピュラーなのがヘルプファイル(*.hlp)かなと思います。 これは機能毎のヘルプを呼び出すことができたり、検索などもできたりと親切なものです。 しかし作る側からするとなにかと面倒なので私はほとんど作っていないです。（一番始めに作ったオンラインソフトに付けただけかな） 作る側が楽なのはプレーンテキスト(*.txt)にダラダラと説明を書いただけのものかと思います。 しかし見るほうには不親切かなと思いますが、たいした量が無い場合などはこの程度でいいと思います。 他に最近はHTML(*.html)でのヘルプを配布しているものも見かけます。 ブラウザで表示してヘルプファイルと似た感じの表現にできますが、複数のファイルや画像を配布してしまうことになってしまいます。 インターネット上に置くのも手ですがスタンドアロンな環境やインターネットに接続されてないLAN内などの場合は見ることができないです。
ということでユーザのことを考えるとヘルプファイルを付属させることが望ましいです。 しかし親切であることは色々と大変な面が多くて折角付属したヘルプを読まない、もしくは読んでも分からないという人は結構います。 お金を貰っている場合はいざしらず、無料で作ってる場合などヘルプを読まない人や理解してくれない人に対して１から説明をしていてはキリがないと思います。 逆に理解してくれる人はヘルプを読まないでも理解してくれるものです。（但し標準的なUIを使用するなどしてないと無理） CUIなOSの場合はヘルプを読まないと使えないというのは当たり前ですが、GUIなOSの場合はヘルプを読まないでも使えるソフトというのは結構みかけます。 ということで逆にヘルプを読んでも理解できない人に質問をされないためにの荒業としてヘルプに専門用語をバシバシ使ってみることです。 そすると見て分からない人はドキュメントを見ただけで使う気を無くしてしまうので初歩的な質問は来ないでしょう。
上記は半分冗談で半分本気なのですが、裏を返せば専門用語を使わなければ初心者でも分かりやすいヘルプになると言う事です。 当たり前といえば当たり前なことなのですが、これが簡単なようで結構難しくて色々見ていると結構専門用語は使われているものです。 どこからが専門用語なのか？というのは難しいのですが、自分が基準な場合は初心者には理解してもらえないでしょう。 結構それを実感できるのがチャットです。 チャットで初心者相手に何かを説明してみると何が専門用語なのか良くわかると思います。
あとはヘルプファイルの構成ですが、一般的なものは、
個人的にはヘルプが無くても動かせるソフトというのが望ましいと思うのですが、そうもいかないので私はプレーンテキストのドキュメントを付属しています。 初心者に優しいヘルプを作るか初心者に難しいヘルプ作るかはそのソフトウェアのターゲットに合わせてでいいと思うので書くときに調整してみてはいかがでしょう :-)
(C) Copyright 1996-2000 By Tomoaki Nakashima. All right reserved.
mailito:<nakka@nakka.com>