ソフトウェア製品のドキュメント

理想的なソフトウェアは、エラーのない、その誰もがそれを彼らがアプリケーションを起動する分に精通しているであろう非常に使いやすいでしょう。しかし、これは現実の生活の中でそうではありません。

技術サポート：ソフトウェア製品の品質に加えて、契約しているか、あるいは壊す何か他のものはありません。ソフトウェアパブリッシャーおよびシェアウェアの作者が提供するサポートの向上、より多くのユーザーが製品を購入する可能性があります。

ソフトウェア製品の技術サポートは、いくつかの方法で提供することができます。
オンラインの製品ドキュメント
電子メール支援
ソフトウェア発行者によって維持されるフォーラムをサポートするためにアクセスする
知識ベース。


良いドキュメントは、多くの場合、テクニカル·サポートの更なる形態の必要性を除外することができます。しかし、書くことは容易ではありません。これが起こる理​​由の一つは、彼らがすでにアプリケーションを熟知しているのでシェアウェアの作者や他のソフトウェア開発者は、ユーザーのシューズに身を置くことは困難であるということです。

Read Meファイルを

すべてのソフトウェア製品が持つべき最初の事は次のものが含まれますテキスト形式 "Read Me"ファイルです。
製品名とバージョン
出荷日
当社および著者名
内容（ "写真主催者"のような）
新着リスト（これはバグ修正と新機能のリストでなければなりません）
システム要件（CPU、RAMのようなハードウェア、ディスク容量、サポートされるオペレーティングシステム）
価格、支払いオプションと手順
著作権とディストリビューションの情報（製品を配布したい人のためのルール）
連絡先の詳細（メール、電話、ファックス、ウェブサイトおよび住所）


お使いの製品に興味があるかもしれない誰もがレビュー、ユーザー、または雑誌、またはそれらのウェブサイト上の配布用CDに収録されている製品を置きたい人を含め、それを期待しているので、 "Read Me"ファイルは重要です。ここでの考え方は、情報を見つけることが困難であるに関連付けられているフラストレーションを最小限にすることである、従って1つの場所にすべてを置く必要があります。

マニュアル

シェアウェアの作成者とソフトウェアパブリッシャーが自社の製品を提供する必要があります他の事はマニュアルです。あなたはそれを書くために起動するときに考えるべき最初の事柄は、ユーザーがそれを使用しようとしている方法です。いくつかは、あなたの製品を使用する前に、そのすべてをわざわざ読まれているものです。彼らは何かをしようとすると、後でそれに頼る可能性が高くなりますし、それを行う方法を見つけ出すことはできません場合、または、彼らが理解できない何かを見つける。

彼らを助けるためには、タスクによって、ドキュメントを整理することをお勧めします。 "どのように..."のセクションでは、単に順番にすべてのコマンドを記録するよりも便利です。彼らは写真や図、可能な限りに裏付けされている場合の説明が理解しやすいです。また、最も一般的な問題に対する回答を提供する "トラブルシューティング"というラベルの付いた章があるはずです。最初にあなたは、これらの問題が発生する可能性がありますどこに推測する必要がありますが、アップグレードのカップルは、ご使用の製品に後から、製品を試してみました人々からのフィードバックは最も一般的な問題が何であるかを教えてくれます。
マニュアルは各章に分割されるべきは、まず他の章に含まれているかわかられるのは、人々は容易に彼らが必要なものを見つけることができるようにすることができます。

インタフェース

言うまでもない価値がもう一つのポイントはインターフェイスです。ユーザーフレンドリーでは十分ではありません、インターフェイスはユーザーがシステム全体の理解を持っていない場合でも、ナビゲートする必要がありますので、画面には、自己記述する必要があります。

オンラインヘルプまたはオンラインドキュメント

オンラインヘルプ、またはオンラインマニュアルもあります。ユーザが読めるようにするためのウェブサイトに置かドキュメントが検索結果に表示する必要があります。これにより、ユーザーは、のような質問を尋ねることは確実だような方法で整理する必要があります "どのようにI.缶..."または "できないのはなぜI. .."すぐに答えを見つけることができます。ソフトウェア製品でさまざまなタスクを行う方法を示す例の多くはまた必要とされている。良いアイデアを理解することはより困難かもしれない用語集へのリンクを含めることです。

常に製品と悪い経験があった誰もが長い時間とソフトウェアのためにそれを覚えている傾向にあることに留意することと違いはありません。あなたは可能な限り滑らかな経験は、何か適切なサポートやマニュアルはあなたが達成することができるようにする製品をご使用にするよう努めなければならない理由はそのためです。...