SEO を考慮して MDN Web Docs を書く方法

このガイドでは、ユーザーが必要なものに簡単にアクセスできるように、検索エンジンがコンテンツを簡単に分類して索引付けできるようにするための標準的なプラクティス、推奨事項、およびコンテンツの要件について説明します。

イントロダクション

MDN を執筆する主な目標は、常にオープンなウェブ技術について説明し、情報を提供することです。それにより開発者は実現したいことをするため、あるいはコードを完成させるために知っておく必要のある詳細を見つけるために学ぶことができます。彼らが、私たちが書いている資料を探し出せることが重要です。

MDN の読者の多くは検索エンジンを経由してコンテンツにたどり着くため、執筆者としてはそのことを念頭に置いて作業をしなければなりません。そのために、 MDN の執筆者や編集者が、それぞれのページが適度にデザインされ、書かれ、マークアップされ、検索エンジンが記事を適切にインデックスするために必要な文脈や手がかりを与えることができるように、「SEOガイドライン」を制定します。

SEO チェックリスト

ページとその周辺が検索エンジンに適切にインデックスされるようにするために、コンテンツを書いたり見直したりする際に確認すべきことを以下にまとめました。

  • ページの内容が他のページとは十分に異なり、検索エンジンが同じことについて書かれていると思わないようにしましょう。
  • 短すぎるページは避けましょう。短すぎる記事 (SEO 用語では「薄いページ」と呼ばれます) は、正確なカタログ化が困難です。 MDN のページは、可能な限り、 300 語程度以下の短さを避けるべきです。

似たようなページにならないようにする

各記事はできる限り固有であるべきです。テキストが似ている記事は、実際には似ていなくても、ほぼ同じ内容であるとみなされてしまいます。例えば、インターフェイスに widthheight というプロパティがある場合、同じ例を使っていくつかの単語を入れ替えただけで、驚くほど似た文章になってしまいがちです。これでは、検索エンジンはどちらがどちらなのか分かりませんし、ページランクも同じになってしまい、結果的にどちらも本来の目的よりも見つけにくくなってしまいます。

当然のことながら、 widthheight のような 2 つの関連するプロパティ (または機能的に関連する他の機能のセット) に直面した執筆者は、 width に関する記事を書き、その記事をコピーして height に関する記事に貼り付け、いくつかの単語を入れ替えればよいと思うでしょう。これで完了。

残念ながら、結果として、検索エンジンが懸念する限りでは、同じものであるかもしれない 2 つのページができあがります。

そのためには、すべてのページに独自のコンテンツを持たせることが重要です。ここでは、それを実現するためのいくつかの提案を紹介します。

  • 意外と違いがあるかもしれない使用例を考えてみます。例えば、 widthheight のケースでは、水平方向の空間と垂直方向の空間がどのように異なる使い方をされているかを考え、適切な概念についての議論を行います。例えば、幅についてはサイドバーを設置するための空間として、高さについては縦方向のスクロールやフッターなどのために使用することを考えます。また、アクセシビリティの問題についての情報を盛り込むことも、有用かつ重要なアイデアです。
  • 各ページにまったく異なる例を使ってください。このような場合の例は、本文よりもさらに似通っていることが多いものです。というのも、例はそもそも似たようなメソッドやプロパティの両方 (またはすべて) を使用していることがあり、再利用する際に実質的な変更を必要としないからです。そのため、例を捨てて新しい例を書くか、少なくとも複数の例を用意し、そのうちのいくつかは異なる例文してください。
  • それぞれの例について説明を加えます。トピックの複雑さと対象読者を考慮して、適切なレベルの詳細で、例が何をするのかという概要と、どのように機能するのかという説明の両方を含める必要があります。

同じような内容になりすぎないようにするには、時間が許す限り、それぞれの記事を一から書き直すのが一番簡単です。

ページが短くなりすぎることを避ける

短すぎる記事 (SEO 用語で「薄いページ」と呼ばれます) は、正確なカタログ化が困難です。 MDN のページは、可能な限り 300 語前後の短さを避けるべきです。ここでは、不必要なテキストでごちゃごちゃさせずに、検索に適した内容のページを作成するための基本的なガイドラインをご紹介します。

  • もちろん、記事がスタブであったり、足りない部分があれば追加します。 MDN では、明らかな「スタブ」ページは避けるようにしていますが、実際には存在します。しかし、コンテンツの大部分が欠けているページはたくさんあります。
  • 一般的には、ページの種類に応じて適切に構成されていることを確認してください。持つべき節がすべて存在し、適切なコンテンツがあることを確認してください。
  • すべての節が完全で、最新の情報が含まれていることを確認してください。すべての引数がリストアップされ、説明されているか。例外がカバーされていることを確認してください (これは特にコンテンツが欠けていることが多い場所です)。
  • すべての項目が詳細に説明されているかどうか。簡単な説明をするのは簡単ですが、すべてのニュアンスが含まれているかどうかを確認してください。特別なケースはありますか?読者が知っておくべき既知の制限はありますか?
  • すべての引数、あるいは少なくとも初級から中級レベルのユーザーが使用する可能性のある引数 (またはプロパティや属性) と、追加の説明が必要な高度な引数を網羅した例を用意する必要があります。それぞれの例の前には、その例が何をするのか、それを理解するためにはどのような知識が必要なのかなどの概要を示す必要があります。例の後 (または例の一部の間) には、コードがどのように動作するかを説明する文章が必要です。例の詳細やエラー処理についても手を抜いてはいけません。読者は例をコピー&ペーストして自分のプロジェクトで使用するでしょうから、そのコードが本番サイトで使用されることになるでしょう。より有用な情報は、コード例コード例のガイドラインをご覧ください。
  • 説明されている機能について、特に一般的な使用例がある場合は、それについて話してください。一般的な開発上の問題を解決するために文書化された方法を読者が理解すると仮定するのではなく、実際にその利用例についての節を追加し、例とその例がどのように機能するかを説明するテキストを追加してください。
  • すべての画像や図に適切な alt テキストを入れてください。このテキストは、表などのキャプションと同様に重要です。スパイダーは画像をクロールすることができないため、 alt テキストによって、埋め込まれたメディアに含まれるコンテンツを検索エンジンのクローラーに伝えることができます。注:検索エンジンのランキングを操作するために、キーワードを入れすぎたり、関係のないキーワードを使ったりすることは、ベストプラクティスではありません。このような行為は発見されやすく、罰せられる傾向にあります。
  • 同様に、ページのサイズや検索順位を上げるために、反復的で役に立たない内容や、キーワードの塊を実際のページ内に追加するようなこともしないでください。これは、コンテンツの読みやすさと検索結果の両方に悪影響を及ぼします。
  • 2013 年に行われた Google のハミングバードアップデートでは、自然言語による情報伝達が重視されるようになりました。つまり、特定のキーワードではなく、記事のトピックに沿ってコンテンツを書く方がはるかに良いということです。実際、多くの SEO 担当者は、記事の長さに応じて 5 ~ 100 種類のキーワード (ショートテール、ミディアムテール、ロングテール) をリストアップし、記事に含めるようにしています。そうすることで、表現が多様化し、繰り返しが少なくなります。

関連情報