こんにちは、Habr！
クライアントはしばしば
Alconostに来てこう言います。「プログラムにはヘルプシステムが必要です。 私をPeDaeFkuにしてください。」 ユーザーマニュアルを作成し、PDFを作成すると、インデックスと検索に関するコンテキストヘルプが本当に必要であることがわかりました。
だからこそ、私はすべての単純なスキームと、ヘルプの種類と形式の説明を共有したいと思います。
この資料は教科書ではなく、この分類は私自身の経験に基づいています。 この投稿は、新しいヘルプを作成したり、既存のヘルプを改善したい人には役立つと思います。
ヘルプの種類
目的に応じて、証明書を次のタイプに分けました。
- ユーザーマニュアルと指示 （オペレーター、プログラマー、管理者）は、ユーザーの資格に応じた一連の指示とソフトウェア機能の説明を含む古典的なリファレンスドキュメントです。 主に印刷用に設計されています（紙版があります）。
- クイックスタート 、 入門 -小型（最大10枚）のマニュアル。その目的は、製品の使用方法と最終結果を得る方法をすばやく教えることです。 完全なガイドがまだない間に作成することも、大規模なヘルプの一部にすることもできます（対応する詳細な説明へのリンクがあります）。
- オンラインヘルプ、WebHelp （オンラインヘルプ）-メーカーのWebサイトで利用できるヘルプ。 通常、サイトのスタイルで作成されます。 ローカルディスクに保存する必要がなく、検索とキーワードが組み込まれているため、非常に便利です。 オンラインヘルプは、SEOの改善に役立ちます。
- Wiki （wiki）-サイト自体が提供するツールを使用して、ユーザーが独自に変更できるWebサイト、構造およびコンテンツ。 長所：ユーザーは自分でヘルプを記述します。 短所：wikiレイアウトを学ぶ必要があります。wikiエンジンをインストールする際に困難があります。
- 「方法」の記事は、特定の問題を解決することを目的とした記事（またはヘルプセクション）です（例「ローカルネットワーク上のコンピューターでUSBデバイスを共有する方法？」）。 原則として、このような記事には、いくつかのスクリーンショット、考えられる問題の説明、およびそれらの解決策を含む特定の一連のアクションが含まれています。 これらのテキストは、ネットワーク上のキーワード（キーワードを含む）への配置に使用でき、製品のプロモーションに役立ちます。 ハウツー記事の最後に、チュートリアルビデオを投稿できます。
- FAQ （FAQ）-それらへの質問と回答; 多くの場合、トラブルシューティングセクションの後のヘルプの最後にあります。 これらの問題の大部分を予測し、ヘルプでそれらを開示する場合、サポートサービスの負荷を大幅に減らすことができます。 このセクションは、手紙やユーザーのレビューに基づいて絶えず更新することをお勧めします。
- EULA （ライセンス契約）、 利用規約 、 プライバシーポリシー -メーカーとユーザーの法的関係を規定し、当事者の責任を確立し、著作権も示す参照ドキュメントのセクション。 これらのテキストの執筆を弁護士に委ねることは、あなたのプログラムの助けを借りて、ペンタゴンのネットワークを破壊する責任をあなたに負わせるためです。
ヘルプ形式
証明書の種類とその場所に応じて、1つまたは複数の形式が選択されます。
- DOC（RTF） -ドキュメントの一般的な形式。 任意のプラットフォームでヘルプを開き、さまざまなエディターにインポートする場合は、RTF形式に変換します。
- HTML-オンラインヘルプの形式。 ローカルコンピューターで開くこともできます。 通常、オンラインヘルプはHTML、CSS、およびJSファイルを含むディレクトリです。
- CHM-この形式は主にWindowsアプリケーション（F1）の状況依存ヘルプを対象としています。CHMドキュメントは圧縮されたHTMLページとイラストで構成されています。 ネットワークからダウンロードしたCHMファイルを開く際の問題を修正するには、無料のHHRegユーティリティを使用できます。
- PDF-印刷に使用されるヘルプ形式。 この形式にエクスポートする場合は、CIDフォント（Unicodeを設定することをお勧めします）、テキスト圧縮（最大）、および画像の形式に注意する必要があります。そうしないと、最終的なPDFファイルが大きくなりすぎます。
- EXE （e-Book）-Windows実行可能ファイル。 長所：追加の表示ソフトウェアは必要ありません。 短所：ウイルスが含まれている場合がありますが、PDFほど印刷には適していません。 Macでは表示できません。
- HXS（MSHC） -Visual Studioのヘルプ形式（MS Help 2およびMS Help 3エンジン）。 ファイルは、htmlファイルと画像を含むzipアーカイブです。 主にコードの文書化に使用されます。
- ePUBは、モバイルプラットフォーム（iOS、Android、さまざまなメーカーの電子書籍リーダー）向けのヘルプ形式です。 PCでePUB形式のヘルプファイルを表示するには、無料のユーティリティAdobe Digital Editionsを使用できます。
ヘルプのタイプと形式を選択する方法は？
上記の説明と図を読み、2つの主な質問に答えてください：「誰が私の助けを読むのですか？」、「どこで（そして何を）読むのか？」 そして、一度にすべての場所に落ちます。
さまざまな種類の参照資料の例を次に示し
ます。https :
//alconost.com/services/help-authoringこの困難な選択を支援することを願っています。 ご質問やご提案をお待ちしております！
著者についてAlconostは、60の言語で
アプリケーション、ゲーム、およびサイトをローカライズします 。 ネイティブ言語の翻訳者、言語テスト、APIを備えたクラウドプラットフォーム、継続的なローカリゼーション、24時間365日のプロジェクトマネージャー、あらゆる形式の文字列リソース。
また、Google PlayとApp Storeの販売、画像、広告、教育、ティーザー、エクスプライナー、予告編のサイト向けに、
広告および教育用ビデオを作成しています。
続きを読む：
https :
//alconost.com