オンライン ドキュメント (ユーザー マニュアル、API リファレンス、ヘルプ センター、製品ガイド) は、PDF または Web ページ (HTML) として公開できます。形式の選択は、ユーザーがコンテンツを見つけて読む方法、更新の容易さ、モバイルで適切に動作するかどうかに影響します。それぞれに真の強みがあり、多くの組織が両方を異なる目的に使用しています。
HTML ドキュメントの機能を向上させる方法
HTML ドキュメントは Web ネイティブです。検索エンジンは個々のページにインデックスを付けます。つまり、特定のトピックを検索しているユーザーは、ファイルをダウンロードしてその中で検索する必要がなく、関連するセクションに直接アクセスできます。 Google で「製品のパスワードをリセットする方法」を検索します。ユーザーをヘルプ コンテンツの 47 ページに直接誘導できます。これは、ダウンロード リンクの背後にある PDF では不可能です。
HTML はあらゆる画面にも適応します。モバイル ユーザーは、固定レイアウトのページをズームしたりスクロールしたりせずにドキュメントを読むことができます。ファイルを置き換えずにコンテンツを更新できます。タイプミスを修正したり、スクリーンショットを更新すると、変更はすべてのユーザーに即座に適用されます。また、HTML ドキュメントには、ユーザーがワンクリックでコピーできるコードサンプル、展開可能なセクション、埋め込みビデオ、すべてのコンテンツにわたるライブ検索などのインタラクティブな要素を含めることができます。
PDF ドキュメントの利点
PDF ドキュメントはオフラインでも動作します。マニュアルをダウンロードしたユーザーは、飛行機内、接続が制限されているデータセンター内、または電話が許可されていない環境で機器を操作しているときに、インターネットにアクセスしなくてもマニュアルを読むことができます。ハードウェアのドキュメント、工業用マニュアル、または現場で使用される技術リファレンスの場合、これは実用上大きな利点となります。
PDF は、確実に印刷できる固定レイアウトも維持します。技術者が印刷されたチェックリストやインストール ガイドに基づいて作業する必要がある場合、ブラウザやプリンタが異なると予期せず再フォーマットされる可能性がある HTML よりも、毎回正しく印刷される PDF の方が適しています。
特定の製品バージョンを表す正式なドキュメント (ソフトウェア バージョン 3.2 のマニュアル、特定の製品リリースの仕様) の場合、PDF は変更されない固定レコードを作成します。 HTML ドキュメントは常に最新であり、これは通常は良いことですが、ドキュメントの履歴バージョンは、特にバージョンを指定しない限り保存されない可能性があります。
発見可能性: 最も重要な要素
ほとんどのオンライン ドキュメントでは、見つけやすさが決定要因となります。ユーザーがヘルプを検索する必要があり、Google またはサイトの検索を通じて見つける必要がある場合は、HTML が断然有利です。 PDF コンテンツは、検索エンジンによってインデックス付けされることが増えていますが、それほど細分化されていません。PDF の特定のページを指す検索結果は、質問に答える HTML セクションを直接指す検索結果よりも役に立ちません。
ドキュメントが検索ではなく主にナビゲーションを通じて見つかる場合 (ユーザーはどこに行くべきかをすでに知っています)、発見可能性のギャップはそれほど重要ではなく、他の要因が影響します。
一般的なハイブリッド アプローチ
多くのドキュメント チームは両方の形式を公開しています。主要なドキュメントは HTML として保存されており、検索可能でモバイル対応で常に最新です。完全なマニュアルをダウンロード、印刷、またはローカル コピーを保存したいユーザーのために、同じコンテンツから PDF エクスポートが生成されます。 Sphinx、MkDocs、GitBook などのツールを使用すると、最小限の追加作業で同じソース コンテンツから両方の出力を生成できます。
このハイブリッドにより、1 つの形式を排他的に選択することによるトレードオフが回避されます。オンライン ユーザーは、検索可能で応答性の高い HTML エクスペリエンスを得ることができます。オフラインまたは印刷可能なバージョンが必要なユーザーは、クリーンで適切にフォーマットされた PDF を入手できます。コンテンツは 1 か所で維持され、両方の形式で公開されるため、追加のメンテナンスの負担はありません。
どちらかを選択する場合
ドキュメントが主にオンラインで使用される場合、検索エンジンの可視性が重要である場合、コンテンツが頻繁に変更される場合、またはモバイル アクセスが重要な場合は、HTML を選択してください。ユーザーがオフライン アクセスを必要とする場合、ドキュメントを印刷する必要がある場合、製品の修正バージョンを表す場合、またはスタンドアロン ファイルとして配布する必要がある場合は、PDF を選択してください。ほとんどの最新のソフトウェア製品およびサービスでは、PDF ダウンロード オプションを備えた HTML ドキュメントが両方のベースを効率的にカバーしています。