効果的な検索のためのヒント
このページは PageTurner AI で翻訳されました（ベータ版）。プロジェクト公式の承認はありません。 エラーを見つけましたか？ 問題を報告 →
DocSearchはほぼ全てのウェブサイトで動作しますが、特定のサイト構造ではより関連性の高い結果や高速なインデックス作成が可能であることがわかっています。このページではDocSearchを最大限活用するためのヒントを紹介します。
sitemap.xmlの活用
設定でサイトマップを提供すると、DocSearchはインデックス対象ページを直接参照できます。ページは依然クロールされるため、適合する全てのリンクが抽出されます。
まだサイトマップをお持ちでない場合、sitemap.xmlの追加を強くお勧めします。これによりインデックス作成が高速化されるだけでなく、インデックス対象ページの制御も容易になります。
サイトマップはSEOなど他の観点でもベストプラクティスとされています（サイトマップの詳細）。
情報階層の構造化
DocSearchは構造化されたドキュメントでより効果的に機能します 。検索結果の関連性はコンテンツの階層構造に基づいています。つまり、ページの<h1>～<h6>見出しを解析して情報階層を推定します。この階層構造によりレコードに文脈情報が付与されます。
ドキュメントは一般的な概念から始まり、徐々に詳細な説明へ進みます。これはHTMLマークアップにおける見出し階層で表現されます。例えば、同じページ内で<h4>タグ下の概念は<h2>タグ下の概念よりも詳細です。ページ内で早く出現する情報ほど高いランク付けされます。
DocSearchはこの構造を活用して結果の関連性を微調整し、フィルタリング機能を提供します。このパターンに沿ったドキュメントでは検索結果の関連性が向上します。
ドキュメントツリーの適切な深さの決定とコンテンツ分割は最も複雑な作業の一つです。大規模ページでは4階層（lvl0～lvl3）を推奨し、少なくとも3階層を確保してください。
<hX>タグを使用せずクラス（例: <span class="title-X">）で代替できる点に留意してください。
コンテンツ領域に一意なクラスを設定
DocSearchはHTML構造に基づきコンテンツを抽出します。テキストコンテンツ全体を囲むHTML要素にカスタムclassを追加することを推奨します。これにより関連コンテンツへのセレクタが絞り込まれます。
一意な識別子を設定することで、ヘッダー・サイドバー・フッターの検索に関連しないコンテンツを確実に除外でき、設定の堅牢性が向上します。これが最も信頼性の高い方法です。
見出しにアンカーを追加
前述の見出しを使用する際、各見出しにカスタムアンカーを追加してください。アンカーはヘッダーに追加するHTML属性（nameまたはid）で定義され、ブラウザがページ内の正確な位置までスクロールできます。#に続けてアンカー名を指定したリンクでアクセス可能です。
DocSearchはこれらのアンカーを認識し、ユーザーが選択した検索結果に最も近いアンカーへ自動的に移動させます。
ナビゲーションでのアクティブページのマーキング
マルチレベルナビゲーションを使用する場合、各アクティブレベルにカスタムCSSクラスを付与することを推奨します。これによりDocSearchが現在ページのサイト階層内での位置を把握しやすくなります。
例えば、troubleshooting.htmlページがサイドバーの「インストール」メニュー下にある場合、サイドバーの「インストール」と「トラブルシューティング」リンクにカスタムCSSクラスを追加してください。
CSSクラス名は、CSSセレクタの一部として使用可能であれば何でも構いません。
コンテンツの一貫性
一貫性は意味のあるドキュメントの基盤です。これによりドキュメントの理解しやすさが向上し、ユーザーが求める情報を見つけるまでの時間が短縮されます。ドキュメントのトピックは識別可能であるべきで、そのアウトラインは明確に区分されている必要があります。
階層構造は常に同じサイズを保つべきです。イントロダクションや結論、補足説明などの孤立したレコードを避けるよう心がけてください。セレクターはすべてのドキュメントにおいて効率的であり、適切な階層を明示する必要があります。各レベルに応じて対象要素を正確にマッチングさせる必要があります。予期せぬ余計な要素をマッチングさせることで生じるエッジ効果に注意しましょう。
セレクターは実際のドキュメントページから情報を取得し、ランディングページや目次ページな ど他のページでは無効となるようにします。メンテナーには、実際のドキュメントコンテンツ（例：.DocSearch-content）を含むメインDOMコンテナに専用クラスを定義することを推奨します。
ドキュメントはインタラクティブであるべきなので、標準化された言葉で概念を表現することが重要です。この冗長性は検索体験（ドロップダウン）によって強化され、入力しながら学ぶ体験を可能にします。情報を見つける方法は、ユーザーを検索結果の知識へ導く上で重要な役割を果たします。シノニム機能の活用も検討してください。
重複を避け一意性を促進する
ドキュメントを読むのに時間がかかればかかるほど、その利用は煩わしく消極的になります。曖昧な点や網羅的な記述は避ける必要があります。網羅的なドキュメントは役に立たないだけでなく、混乱を招き逆効果になる可能性があります。
重複はノイズを生みユーザーを誤解させます。そのため、関連性の高いコンテンツに集中し、サイト内でのコンテンツ重複（例：すべての情報を含むランディングページ、まとめページなど）を避けるべきです。異なるデータセット（例：別バージョン）に属するために重複が予想さ れる場合は、ファセットの使用を検討してください。
簡潔さ
明確に考え抜かれたものは、明確かつ簡潔に表現されます。
技術ドキュメント向けの有用な検索機能構築に関するこちらのブログ記事の一読を強くお勧めします。