MDNページの要約を定義することができます。この要約は色々な方法で使われて、それには検索エンジンの結果や、トピックランディングページやツールヒントといった他のMDNページが含まれます。要約は、ページのコンテキストと、他のコンテキストで表示される両方の場合で、ページの残りの部分がなくても意味をなす文章であるべきです。
要約は、ページ内に明示的に定義できます。明示的に定義されていない場合、典型的には最初の文などが使われますが、これが常に目的に対してベストなものではあるとは限りません。
- なすべきタスクは?
- ページ内に、その他のコンテキストで要約として使われるべきテキストを作成します。つまり必要に応じて適切な文章を書くこともあるかもしれません。
- どこでなされる必要があるか?
- 要約のないページや、ないよりましの要約があるページ。
- このタスクを行うのに要る知識は?
- MDN エディターを使えること、文章を書くスキル、良い要約を書くために、トピックに十分通じていること。
- タスクの手順は?
-
- 要約を載せるページを選ぶ:
- MDN 文書化ステータスのページで、知識のあるトピック(例えばHTML)の節の下のセクションをクリックする:
- トピックの文書化ステータスのページで、Summary 表の Pages をクリックする。トピック節の全ての目次が出る。つまり左のカラムにはページのリンクが、右のカラムにはタグと要約が表れる。:
- 要約のない、または悪い要約があるページを選択:
- リンクをクリックしてそのページへ移動する。
- MDN 文書化ステータスのページで、知識のあるトピック(例えばHTML)の節の下のセクションをクリックする:
- 編集 をクリックして、MDNエディター内にページを開く。
- 文脈から、要約になりそうな1つか2つの文章を探す。必要な場合、既存の内容を編集して、良い要約となるような文を作成/編集する。
- 要約とする文を選択する。
- エディタツールバーの スタイル ウィジェットで、SEO Summary を選択する。 (ページのソースでは、選択したテキストの前後に、
class="seoSummary"
をつけた<span>
要素が作成される) - リビジョンのコメントをつけて保存する。コメントは必須でないが、付けるのを勧める。付けておけば、他の人が変更を追いかけるのが簡単になる。
- 要約を載せるページを選ぶ: