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

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

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

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

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

開発者、管理者、またはコード学習者など、コンテンツの特定の対象ユーザーを理解し、書き込みます。この記事をお読みいただくことで、以下の知識が得られます。

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

次のような「GitHub Docs のベストプラクティス」のガイダンスに従ってください。

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

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

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

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

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

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

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

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