it-swarm-ja.com

どのタイプのヘルプシステムが最適ですか?

私の会社では、Windowsベースのデスクトップアプリケーションを作成しています。以前は、ヘルプドキュメント用の.chmファイルを作成しており、満足しています。現在、.chmの作成に使用するソフトウェアに関するいくつかの問題に直面しており、この.chm作成ソフトウェアを引き続き使用するには、基本的に多額の投資が必要になるため、この質問につながりますAre。 chmファイルは、ヘルプドキュメントを提供するための本当に最良の手段ですか?

目次やドキュメント内の他のセクションにジャンプするリンクなど、.chmファイル内のすべての要素を使用してPDFを作成するための調査を行いました。オンラインヘルプはオプションではありません。どのようなソリューションを選択しても、インターネットに接続しなくてもhasが機能します。

繰り返しますが、どのタイプのヘルプシステムが最適ですか?.chmファイルの代わりにPDFを使用できますか?別のより良い代替手段はありますか?

更新:いくつかの理由で.chmを使用する必要があるようですが、主に更新と配布が容易であるためです(1つのファイルのみ)。これまでの私のランナーはhtmlヘルプでした。これは本質的に.chmとにかくです。

13
Matt Rockwell

人々は読んでいない。最善の助けは助けにならない。もちろん、それを行うには、膨大な時間をかけてUXに取り組む必要があります。

したがって、ヘルプが必要な場合は、最新のヘルプ情報を使用してWebサイトにリンクできる状況依存ヘルプが最善であることをお勧めします。ヘルプをHTMLとして公開し、独自のCHM制作ワークフローから解放されます。

11
DA01

他の人が言ったように、あなたはあなたの製品に役立つHTMLファイルを生成することを検討するべきです。当社の製品の1つ(インターネットアクセスのない環境で使用)はこれを何年も行っており、多くのユーザーは、ナビゲーションが簡単で、コンテンツがブラウザーウィンドウに合わせてレイアウトされ、チャンクであるため、当社が出荷するPDFよりもそれを好んでいますサイズは小さいです。 HTML構成は状況依存ヘルプもサポートしていますが、まだ実装していません。

PDFはページベースドキュメントの素晴らしいプレゼンテーションですが、ユーザーがそれを読むために水平スクロールを避けたい場合は、かなりのビットを割り当てる必要があります画面の不動産。アプリケーションで必要なモニターのサイズとスペースによっては、アプリケーションと一緒にヘルプを表示できない場合があります。これは、ドキュメントを使用して手順を進める場合の妨げになります。ステップごとの手順。

最初の段落で暗示されているように、適切なツールがあれば、複数のフォーマットを生成することは難しくありません。 HTMLとPDFの両方を生成して出荷できない理由はありません。ユーザーにオプションを提供します。

8
Monica Cellio

技術文書の自動生成には、DocbookやDITAなどのXML発行形式を使用できます。特に、DITAはPDF、CHM、RTF、HTMLを生成できます。

私は Serna Freeエディター を使用しました。これは、XMLの詳細を削減するために、DITAに優れたビジュアル編集サポート(WYSIWYG)を提供します。

ただし、技術文書はエンドユーザーとのコミュニケーションに最も効果的な方法ではありません。ますます、インタラクティブなプロトタイプがユーザーとのコミュニケーションに使用されています。例として、 Google+デモ を見てください。この種のプロトタイプを作成するには、費用がかかる場合があります。ただし、UXDプロセスを使用する場合、これらのプロトタイプはプロセスの多くの段階で使用できます。だから彼らは努力する価値があるかもしれません。

4
Pau Giner

PDFは不適切なオプションです:

  • これはページ指向なので、画面上で読むのは面倒です。 PDFは、読みにくいほど小さいスクロールと大量のスクロールから選択できます。
  • 他のものと比較して検索は処理がひどく遅い
  • 一部の人々は、PDFに関連付けられた一部の製品に強く否定的に反応します。非常に厳しいITポリシーを持つ会社のAggrobat嫌悪を想像してみてください
  • PDFは印刷形式であり、読み取り形式ではありません

PDFにする必要がある場合

  • ページの横向きフォーマット
  • インデックスを作成するジェネレーターを使用する
  • まともなPDFリーダーをアプリケーションにバンドル(もちろんオプションでインストール)

ヘルプをどのように作成しますか?

私は、HTMLを直接編集しているテックライターのために行きます。 Sharepoint Designerは無料で、「Wordと同じように機能します」(実際の引用)、スタイル、クロスリンクなどに関するいくつかの設定とルールが必要ですが、うまくいきました。

HTMLをCHMにバンドルするかどうかは、それほど重要ではありません。プレーンHTMLに対するCHMの主な利点は、インデックスと全文検索です。クライアントサイトのHTML検索エンジンはいくつかありますが、使いやすいものは見つかりませんでした

フォーマットよりコンテンツ、今日のユーザーのために書いてください

PDF上記で打ちましたが、コンテンツは最終的なラッパーよりも重要であると主張します。PDFの優れたマニュアルは、平凡なものに勝ります脳に直接ダウンロードできます。

UIの進歩により、ユーザーの行動は大きく変化しました

  • ユーザーは、マニュアルを読む必要がないことを期待しています。あなたのソフトウェアがマニュアルを読むことを要求するならば、あなたのソフトウェアはひどいです。 (残りの<1%のユーザーがdoカバーツーカバーを読んで不正確なスクリーンショットと小さなスペルミスを指摘するようです)
  • ユーザーは立ち往生しているときにマニュアルを参照します
  • ユーザーは検索に目を向け、さまざまな検索用語を試し、段階的に検索します。

ダイアログやメニュー項目の長いリストを文書化することにあまり意味がありません。タスク指向のマニュアル、多数のハウツーおよびサンプルシナリオを提供します。質問に答える。ダイアログの要素(説明が必要)は説明しないでください。ダイアログの要素が他の要素とどのように相互作用し、結果に影響するかを説明します。

HTMLのインタラクティブ機能を使用します。ビデオ、オーディオ、製品ページへのリンクなどを埋め込むことができます。

3
peterchen

答えなければならない重要な質問は、個別のヘルプを提供するか、状況依存のヘルプメカニズムを提供するかです。一方、他方、またはその両方が、おそらくツールの選択に影響します。

あなたがそれらについてどう思っているかに関係なく、アドビは一般的にアプリケーション内にかなり良いヘルプメカニズムを持っています。私が見ることができることから、それらはCHMのオーダーメイドの代替品ですが、HTMLベースのようです。私はそれらの最新バージョンを持っていないので、彼らが今どうやってそれをやっているのかわかりません。

Rogerが言うように、ブラウザで実行されるHTMLヘルプシステムを生成できるツールが世の中にあります。しかし、繰り返しになりますが、これらの有用性は、あなたがあなたの助けを必要とする状況依存性に依存するかもしれません。

2
Sam K

アプリケーションによっては、多かれ少なかれオンラインヘルプが非常に役立ちます。一部のフォームは他のフォームよりも優れています。いくつかは生産または維持がより簡単です。

多くの場合、ユーザーガイドが必要であり、それが主要なドキュメント作成作業を促進します。その後、オンラインヘルプは、ガイドが印刷されずにPDFとしてのみ存在する場合でも、本のようなガイドの再利用または派生フォームとして機能します。

これらの取り組みは、大丈夫かもしれませんし、お粗末かもしれません。単にPDF=画面上で叩くのはよくありません。プログラムで役立つようにするには、ユーザーガイドの(再)編成、ブックマーク、ハイパーリンク、検索機能にいくつかの作業を加える必要があります。

視聴者、注意の持続時間、印刷物の必要性に基づいて配信形式を選択する必要があります。内部のビジネスアプリケーションはトレーニングクラスを必要とします。これは、本やその他のトレーニング成果物の需要を促進することもできます。

ユーザーが使用している間、アプリケーションが何も説明したり、ユーザーに追加のヘルプを表示したりせずに問題がなければ、開発者は大当たりし、おそらくライターと技術コミュニケーターのチームが一緒に働いていました。

そんなことはほとんどありません。ほとんどすべてのソフトウェアで、アプリ内に、「方法」や「このツールの機能」のヘルプトピックを表示する必要があります。最近では、最も簡単な方法は、CHM(コンパイル済み)ヘルプとHTMLベースのヘルプであり、JavaScriptを介して対話機能を提供しています。高価なヘルプ開発環境の1つを使用するか、無料のエディターを使用して、CHMと同じHTMLヘルプシステムを作成できます。ライブラリ、FARヘルプコンパイラ、ほぼ無料のCHM/Javascriptワークショップの組み合わせのようなもので多くの成功を収めました。

HTML5がオンラインのドキュメントやヘルプシステムにアクセスするための手段であると確信しました。 Javascript、CSS、SVGグラフィックス、多くのライブラリを使用して、アニメーション、ビデオ、全文検索、AI、3Dなどを含む、あらゆるWebサイトのすべてのインタラクティブ機能を提供できます。

コードエディターだけにはないライティングツールと言語ツールが必要なため、これらすべてに最適な開発環境はありません。複数の出力形式を約束する大きなパブリッシングパッケージがありますが、PDF、CHM、HTMLのオーサリングと出力を完璧に行うことは不可能です。

Visual Studioとコンテンツ管理データベースおよびワードプロセッサ(おそらくWord)は、動的HTML 5ヘルプシステム用のツールの1セットです。したがって、フレアまたはFrameMakerになります。 HTMLで直接作業する必要がある場合は、おそらくWebエディター(MS Expressions Web、Dreamweaverなど)が必要です。 Photoshopまたはその他の画像エディター、および多目的なキャプチャツールが必要です。

最も重要なのは、優れたオンラインヘルプが必要な場合、経験豊富なテクニカルライターが必要です。テクニカルライターは、本当にインタラクティブなドキュメント開発者であり、コミュニケーションスペシャリストであり、「ライター」であることに変わりはありません。

0
user8356