最近のヘルプファイルの扱いはどうですか？

https://stackoverflow.com/questions/1433869

07-07-2019
|

質問

だから、デスクトップシステムで実行するアプリケーションをDelphiまたは.NETで作成します。あらゆる種類の機能と優れた機能を備えた優れたGUI。それはうまく機能し、テストではバグがほとんどないことがわかり、デプロイしようとしています...

待って！ヘルプファイルが必要なので、ユーザーはアプリケーションから状況依存ヘルプを呼び出すことができます！

かどうか？最近のヘルプファイルは本当にデスクトップアプリケーションの要件ですか？そして、「Day of birth」というラベルの付いたこのフィールドに自分の誕生日を記入しなければならないことを伝えるために、ユーザーの手をつないで状況依存型にする必要が本当にあるのでしょうか？または、ヘルプファイルが少し古くなっていますか？

これは私が疑問に思うものであり、これは少し主観的なものです。そのため、デスクトップアプリケーションを開発するすべての人に、別の質問をします。状況依存ヘルプファイルを提供しますか？

はい、またはいいえ、お願いします。気軽に主観的なテキストを追加してください。しかし、私にとって重要なことは、現代の開発者がGUIアプリケーションに状況依存ヘルプを追加しているかどうかを知ることです。

（ところで、私自身は、手動で印刷できる非コンテキストPDFファイルに移行しました。メンテナンスがずっと簡単です。）

解決

はい、そうです。

理由：プログラムがどのように機能するかをユーザーが知ることを期待することはできません。では、「誕生の日」に何を入力する必要があるかを説明してください。フィールドは少し極端ですが、通常はソフトウェアシステムにより複雑なものがあります。今日、原価計算システムのヘルプファイルを作成する必要がありました。このファイルには、計算に使用する価格を決定するシステムの仕組みが記載されています。このヘルプファイルを使用せずにシステムを構成する方法を知っているユーザーはいないと思います。

他のヒント

開発者ではなくユーザーとして話す-はい、状況依存ヘルプファイルが必要です。

たとえば、私は現在、新しいプロジェクトに含めるサードパーティのコントロールを評価しています。コンテキスト依存ヘルプが優れているコントロール（つまり、プロパティウィンドウでプロパティを選択するか、コードでキーワードを選択し、F1キーを押してヘルプトピックに直接移動できます）は、はるかに簡単に学習して使用できます。

現在はありませんが、多くのWindowsアプリを作成していません。ほとんどはウェブベースです。ほとんどのWindowsアプリはかなり小さく、ヘルプファイルの外部に十分に文書化されています。

また、開発プロセス中にエンドユーザーにドキュメントを作成してもらうため、ドキュメントは理解できるものです。

ただし、多くのユーザー向けの大きなアプリ（内部アプリではない）を作成している場合、状況依存ヘルプファイルを含めます。私は過去に大きなアプリのいくつかでそれをやったことがありますが、内部以外の状況では非常に役立ちます。

実際には、「助けが必要」なウェブサイトを設計しています。コンテキスト依存の機能であり、その機能は好評を博しています。現在、会社のWebサイトでも社内でも、すべてのWeb開発にそれを取り入れています。

助けない？それは技術的に傾いていて、新しいソフトウェアをいじりたい人にとっては問題ありません。しかし、あなたのソフトウェアがハイテクに精通していない人々によって使用されるのであれば、助けは不可欠です。日付の例を見てください。国際市場がある場合は、プログラムに必要なものを詳しく説明してください。アメリカ人はMM / DD / YYYY形式を使用しますが、ほとんどの国際ユーザーはDD / MM / YYYY形式を使用します。プログラムに必要なものを詳しく説明する必要があります。

私は多くの開発者と協力してきましたが、彼らはエンドユーザーとその運用方法についてまったく手がかりがありませんでした。たとえば、新会社を主張したCTOは、更新があるたびに顧客がすべてのPDFとほとんどのヘルプトピックを印刷したことを知らずに、印刷可能なドキュメントを廃止する必要があります。エンドユーザーと市場を知る必要があります。残念なことに、他の開発者に囲まれたバブルに住んでいる開発者が多すぎます。

開発者はヘルプを書くべきですか？おそらくない。典型的なエンドユーザーのように真剣に考えることができる場合を除き、メモを下書きしますが、テクニカルライターはエンドユーザーが必要とするレベルまで技術情報を分解します。

最近のアプリケーションでは、状況依存ヘルプを提供していませんでした。これには、他の何よりも技術的な理由がありました（基本的に、ヘルプファイルは多言語のdocbookファイルであり、理論上は状況依存ヘルプをサポートしますが、うまく機能しませんでした）。アプリケーションのウィンドウ/ダイアログごとに1ページがあり、すべてのコントロールが説明されています。ただし、各コントロールにはかなり包括的なツールチップもあり、ほとんどの場合、追加のヘルプは不要です。各ダイアログには、ダイアログ固有のページを表示するためのヘルプボタンがあります。歴史的に、ツールチップテキストをヘルプファイルに保存できましたが、最近のヘルプシステムでは機能しないようです。とにかくリソースに保存されます。

しかし、それは皆のためのアプリケーションではありません。アプリケーションで管理できるネットワークシステム自体は複雑なトピックであるため、とにかくユーザー向けの特別なトレーニングがあり、アプリケーションは、ネットワークシステムを知っていればアプリケーションもわかるように設計されています。言い換えれば、アプリケーションモデルはユーザーモデルと非常によく一致するため、包括的なヘルプ機能は必要ありません。これは、あらゆるアプリケーション開発の目標であるべきです。

コントロールに関するヘルプファイルのほとんどの情報は、ツールチップに既に表示されている情報よりも多くはありません。これ以上誰も必要としないからです。

OfficeとVisual Studioはかなり似た問題を解決しました-ヘルプを押すと、単一のコントロールではなく、ダイアログ全体のヘルプページが開きます。

追加の説明を必要とするほど複雑なダイアログの一部がある場合（そして、簡単に再設計できない場合）、コントロールのすぐ隣に説明を置くことができます。これは、多くのアプリケーションで特別な場合に使用されます。そのため、ユーザーは、たとえば特定のテキストの記述方法。

アプリケーションで状況依存ヘルプを提供したことはありません。また、他のアプリケーションで自分で使用できるほど十分に実装されているのを見たこともありません。私の意見では、それを行うために必要な努力は利益を大きく上回っています。

この決定を下す必要のある最後のアプリケーションでは、アプリケーションでツールチップバルーンを使用しました。これは、ユーザーが各コントロールにカーソルを合わせたときにテキストバルーンを表示しました。また、従来のマニュアルも提供しましたが、これは主にウォークスルーであり、多くの段階的なスクリーンショットがありました。

しばらくすると、ユーザーはバルーンにうんざりして、提供されたチェックボックスでそれらをオフにしましたが、初心者が始めるのに役立ちました。

すべてのアプリケーションには、アプリケーションのすべての重要な機能に関するツールチップ（Office 2007のヒントと同様）の形で状況依存ヘルプがあります。

従来の完全なヘルプファイルは提供していませんが、定期的に更新するナレッジベースは間違いなくあります。これは、すべての問題について電話、メールなどを介してクライアントに提供されるすべてのヘルプのコレクションであり、適切に分類され、簡単に検索できます。これは最終的に、クライアントが最初に必要だと思うものではなく、クライアントが探しているものを多かれ少なかれ含む最高のヘルプになります。

少数のクライアントは常にナレッジベースを一見することなく私たちに連絡することになりますが、それでも私たちは何度も車輪を再発明するのに役立ちます。

私はあなたに個人的な意見を述べますが、私の個人的な好みという事実に裏付けられません。

ヘルプファイルの作成は、すべてが新しく、オンラインリソースが不足していた過去に役立ちました。今日、ほとんどのコンピューターユーザーは直接探索して学習します。ツールチップの形でのコンテキストヘルプは優れており、強く推奨されています。この探索学習のヒントを提供します。

クリックしてリンクする多くのヘルプドキュメントについてはどうですか？まあそれは明らかに素晴らしいですが、私が推測することはほとんどありません。ほとんどの場合、ユーザーは適切なGoogle検索で回答を得ることができます。さらに、この種のドキュメントは高価です。開発者が作成することはできません。関連するスキルとしてテクニカルライティングと明快さで、このために特定の人を雇うか割り当てる必要があります。

この決定を管理しなければならなかった場合、アプリケーションにとって非常に難解で特別な（私はユニークだと思う）機能についてのみ完全なドキュメントを提供します。どのような場合でも、コンテキストヘルプファイルではなく、オンラインチュートリアルを使用する傾向があります。これには、アプリケーションの使用がどのくらい難しいか、最も要求されているホットスポットについての情報を提供するという追加の利点があります（ヒットを評価して、オンラインドキュメントへのリファラー検索クエリを実行します）。

ツールチップと一般的にユーザーのコンピューター能力が向上したため、一部のアプリケーションではヘルプファイルがなくても問題なく動作します。ただし、一部のアプリケーションでは、一般的なトピック情報とアプリケーションの使用方法に関するヘルプファイルが必要です。たとえば、写真アプリでは、ユーザー操作が自明であっても、jpeg圧縮について説明し、ヘルプファイルにいくつかのサンプルを含めることができます。

マイクロソフトは、状況に応じたヘルプの低下の一因であり、良くも悪くもそうです。まず、Visual Studioのヘルプシステムは、控えめに言っても、使用するのが面倒です。第二に、Visual Studioのヘルプシステムの使いやすさが大幅に低下しました。暴言は省略しますが、VS2008ヘルプで関連情報を取得するには、さらに多くのクリックとスクロールが必要であると言えば十分です。これにより、アプリケーションのヘルプシステムの標準が低くなる傾向があります。

ライセンス： CC-BY-SA と帰属

所属していません StackOverflow