ヘルプで提供すべき情報/すべきでない情報

1997年6月23日

今回はヘルプで提供してよい情報の種類と、そうでないものについて考えてみたいと思います。今回のコラムのネタは、AppleGuide Completeという、AppleGuideをつくるための解説本です。素晴らしくきれいにまとめられていたので、紹介してみたいと思います。

別にこの本の内容がすべて真実であると主張しているわけではありません(念のため)。

AppleGuideって何?

Macintoshのユーザーは知っていると思いますので、Windows(Unix、DOS)しか使ったことのないユーザーに向けて説明すると、AppleGuideとはMac版のWinHELP(Windowsの標準ヘルプ機能)のようなものです。OS自体に組み込まれている、ヘルプを表示するためのエンジンです。この上でガイドファイルと呼ばれるAppleGuide書類を表示しますが、これがヘルプの中身になります。

AppleGuideの例1

このエンジンを使うことで、システムに負荷をかけることなく、ユーザーに操作情報などを提供できます。WinHELPと異なるのは、チュートリアル、ヘルプ、ショートカットなど、最初からいくつかの種類を前提として設計されていること、1操作(説明)1パネルを貫いているという点です。

AppleGuideの例2

かなり乱暴な説明ですが、雰囲気はおわかりいただけましたでしょうか?

ヘルプで提供すべき情報

ヘルプで提供する情報の種類として、AppleGuide Completeでは次のように定義しています(原文は英語なので、訳しています)。

すべての操作情報がガイドファイルに適しているというわけではないことに注意する必要があります。とはいえ、次の3種類の問いの答えになるような情報については、ガイドファイルに入れるべきでしょう。

  • どうすればいいの?
    (How do I accomplish this task?)
  • なぜできないの?
    (Why can't I accomplish this task?)
  • この言葉はどういう意味?
    (What is the meaning of this term?)

コメントをつける必要がないくらいの見事なガイドラインです。つまり、操作のしかたトラブルシューティング用語解説はヘルプに入れなさい、ということですね。AppleGuideは操作文の導入部も操作のしかたと見なしているので、いわゆるイントロ文もヘルプに入れて良いことになります。
しかし、この部分だけを見て「なるほど」と感心するのはまだ早いようです。

ヘルプで提供するべきでない情報

ヘルプで提供する情報の種類について説明したあとには、ヘルプで提供すべきでない種類についての説明が続きます。

他の情報については紙のマニュアルで提供したほうが良いでしょう。この種の情報には、ユーザーがパソコンの電源を入れていないときやパソコンが正常に動作していないときに必要となる情報、かなり複雑な事柄を説明する情報が含まれます。ヘルプで提供するのにふさわしくない情報の例を、以下にあげます。

  • インストールのしかた
  • プログラミングツールなどの複雑な内容を持つ情報
  • 怪我などにつながる、取り扱い上のご注意

なるほど。こちらの方もかなりすっきりと割り切っているようです。
これだけ簡潔明瞭に主張されると、「そうか、このガイドラインに従えばいいのか」と思ってしまいそうです。内容についてはともかく、そもそもガイドラインとはこれくらいシンプルにまとまっていなければならないものかもしれませんね。

概要説明は紙マニュアルの方がわかりやすい

いままでAppleGuide Completeに従って、ヘルプで提供する情報の種類を見てきました。しかし、当研究所としては、このガイドラインにどうしても1つ付け加えたいことがあります。
それは、まったく新しい分野のソフトウェアに関しては、操作概念を分かりやすく示した紙マニュアルを添付すべきであるということです。
何故こんなことを言うのかというと、最近購入した、あるソフトウェアのマニュアルに仰天させられたからです。そのソフトウェアは英語版ではバージョン3まで来ているのですが、日本語版は初登場です。それなのに、インストールのしかただけしか紙マニュアルでは説明していません。これは困った!! 基本的な使いかたもわからないぞ. . . 。

思い当たるかたも多いと思います。そのソフトウェアとは、Adobe Acrobat 3.0Jです。日本初登場の新規ソフトウェアなのに、PDFの概念、Acorbatでできること、操作内容などの情報がすべてPDFファイルになっている!! これは許せません。
しかし、今までのガイドラインは満たしているようです。これだけを見ても、あのガイドラインだけでは不備があると言えるのではないでしょうか。

ついでに補足
Acrobatのマニュアルに関しては、他にも言いたいことがあります。マニュアルがもろに英語版の直訳です。WWWリンクに関する説明では、日本語として何を言っているのかわからない部分さえあります。よいソフトウェアもこれでは台なしです。
ところで、ひどい直訳といえば、Macromedia FREEHANDもなかなかのものです。ツール箱にはびっくりしました。巻末を見ると、某英語学校で翻訳したようですね。単に「日本語に翻訳するだけなのだから、英語を良く知っている人に翻訳してもらおう」と考えたのでしょうか。英語版マニュアルの翻訳には、関連分野の語彙や常識、テクニカルコミュニケーションに対する最低限の知識が必要であることを理解していないようです。

ケースバイケースで判断する

ここまでAppleGuideを元にしてヘルプで提供すべき情報について考察してみましたが、どういう感想をお持ちになられたでしょうか? 当研究所としては、厳密に運用すると問題は出てくるものの、簡潔明瞭で優れたガイドラインであるように思います。
何もガイドラインというものは杓子定規で従うものではありません。この研究発表ではたびたびこういう結論になるのですが、今回も例に漏れず、自分で考えて、ケースバイケースで運用する努力を惜しまないことが重要なのではないでしょうか(この運用能力こそ、ノウハウと呼ばれるものです)。
切磋琢磨して、素晴らしいヘルプを生み出していきたいものです。

いかがでしたか? 今回は他社マニュアルの批評も入ってしまいました。不愉快な思いをされたかたがいましたら、お詫びいたします。

なお、今回のネタとしたAppleGuide Completeですが、日本語版は存在しないようです。AppleGuideを作成する立場にない人にはあまり必要のない本だとは思うのですが、一応紹介しておきますとISBN 0-201-48334-3で、$39.95(US)です。

The 1140px CSS Grid System · Fluid down to mobile