Skip to main content

検索でコンテンツを検索できるようにすること

これらの SEO のベスト プラクティスに従うと、ユーザーが検索エンジンを使用して GitHub ドキュメントを見つけるのに役立ちます。

検索エンジンの最適化 (SEO)について

検索エンジンの最適化 (SEO) は、Google や Bing などの検索エンジンの結果で Web コンテンツの可視性を獲得する方法です。 Google 検索は、GitHub Docs の上位の参照元であり、ユーザーにとって最も一般的なエントリ ポイントです。

SEO を向上させるためにコンテンツを計画し記述できます。 SEO を向上させることで、ドキュメントを検索するユーザーのエクスペリエンスが向上します。これは、好みの検索語句を使用して検索する情報を検索する可能性が高くなるためです。

コンテンツ SEO のベスト プラクティス

優れた SEO には、特定の対象ユーザー向けのコンテンツを計画し、検索に使用する単語に注意を向けることが必要です。 記事の SEO の改善には、次のベスト プラクティスに従ってください。

対象ユーザーを選択します。

開発者、管理者、またはコード学習者など、コンテンツの特定の対象ユーザーを理解し、書き込みます。 これにより、以下の知識が得られます。

  • 読者の使用する単語を使用します。
  • ニーズとタスクに関連したコンテンツを作成します。
  • コンテキストと背景情報の適切な量を提供します。

検索意図に応答します

検索意図に基づいてコンテンツを作成: 対象ユーザーのメンバーがオンラインで情報を検索するタスク、質問、または問題に関するコンテンツを作成します。

  • 検索意図の調査の実施。 たとえば、検索エンジンの結果ページ (SERP) で関連のクエリを分析します。
  • ユーザーのニーズを理解します。 顧客フィードバック、ユーザー インタビュー、メトリックなどの、複数のソースを使用します。

明確な言語を使用

次の[GitHub Docs のベスト プラクティス] のガイダンスに従ってください。

  • すべての記事には明確な個別のトピックがあることを確認します。
  • 記事の先頭に優先順位の高いコンテンツを配置します。
  • 明確な見出しのある構造記事。
  • コンテンツの一貫性を保つように[スタイル ガイド] に従って編集します。

キーワードを組み込みます

ページコピーとメタデータにキーワード(対象ユーザーが使用する上位の検索語句)を組み込みます。 たとえば、"課金" について記述しているが、対象ユーザーが主に [コスト] と [支払い] を使用している場合は、代わりにこれらの用語を使用します。

Google と Bing には、関連するキーワードを発見するのに役立つキーワード調査ツールが用意されています。 また、ドキュメント チームは Google Search Console のデータを調べて、GitHub Docs のページにつながる検索用語を理解します。

メタデータを含めます。

フロントマッターでは完全なメタデータを使用します。 使用可能な値は、「YAML front matter の使用」を参照してください。

GitHub Docs では、 intro 要素がページ上の小見出しとして表示され、HTML メタデータの説明として機能します。 記事のタイトルは、HTML ページ のタイトルとして機能します。 良好なSEOのために:

  • タイトルとintroは、補完的でキーワードが豊富になるように記述します。 研究でどのようにレンダリングされるかを考えてみましょう。
  • 検索エンジンで使用されるメタデータでもあるキーワードリッチな代替テキストを使用して、すべての画像を組み入れます。 GitHub Docs スタイル ガイドの「Alt text」をご参照ください。

GitHub Docs スタイル ガイドの「Links」に従って、 と高品質のピア サイト上の他のタスク関連ページに、適切にリンクします。

リダイレクトを慎重に維持することで、受信リンクが壊れるのを防ぎます。

精度を維持します

コンテンツに実際のエラー、スペル、スタイルのないことを確認します。 破損したリンクなどのエラーや、不要なコンテンツを削除したりするために、定期的にコンテンツを監査します。 「リダイレクトを構成する」をご覧ください。