HTTP ヘッダーの記事を作成するには
MDN の HTTP ヘッダーリファレンス は、ハイパーテキスト転送プロトコル (HTTP) のリクエストメッセージとレスポンスメッセージのヘッダーセクションの構成要素である HTTP のヘッダーフィールドを記述します。 HTTP トランザクションの操作引数を定義します。このページでは、 HTTP ヘッダーに対応する新しい MDN リファレンスページを作成する方法を説明します。
前提条件
手順 1 – 文書化する HTTP ヘッダーを探す
- HTTP ヘッダーは、 IETF の各種標準規格で定義されているものが多数あります。
- IANA はヘッダーのレジストリーを管理しており、 Wikipedia は既知のヘッダーフィールドを掲載していますが、すべてがウェブ開発者に関連していたり、公式な標準の一部であるとは限りません。
- 現在の MDN ヘッダーリファレンス概要ページに赤リンクがある場合、これらのヘッダーは文書化するのに良い選択です。
- もし、あなたが選んだヘッダーについて書くことに意味があるかどうかわからない場合は、 MDN 協力者に尋ねてください。
手順 2 – 既存のヘッダーリファレンスページを見る
手順 3 – 新しいページを作成する
- すべてのヘッダーページは /docs/Web/HTTP/Headers/ 以下にあります。
- 新しいページを作成するには、 GitHub の README の指示を参照してください。
手順 4 – 内容を書く
- HTTP ヘッダーページのテンプレートから始めるか、ステップ 2 で見つけた既存の HTTP ヘッダー文書の 1 つからコピーした構造を使用するか、どちらかを選択してください。どちらを選ぶかはあなた次第です。
- 新しい HTTP ヘッダーについて書いてください。
- 以下の節を書くことを確認してください。
- 最初の文がヘッダー名に(太字で)言及し、その目的を要約する導入部テキスト。
- 少なくともヘッダーの種類と、ヘッダーが禁止ヘッダー名であるかどうかを含む情報ボックス。
- この HTTP ヘッダーで利用可能なすべてのディレクティブ/引数/値を含む構文ボックス。
- これらのディレクティブ/値を説明する節。
- このヘッダーの実際の使用例を含む、または通常どこでどのように発生するかを示す例の節。
- 関連する RFC 標準文書をリストアップした仕様書の節。
- 関連するリソースをリストアップした「関連情報」の節。
手順 4a – ページへタグを追加する
すべての HTTP ヘッダーページには、少なくとも "HTTP", "Header", "Reference" のタグが必要です。
手順 5 – ブラウザーの互換性情報を追加する
- 他の HTTP ヘッダーページを見たことがあれば、ブラウザーの互換性一覧表を埋めてくれる {{compat}} マクロがあることがわかると思います。
- 互換性一覧表のページは、構造化データから生成されています。データに協力したい方は、 https://github.com/mdn/browser-compat-data/README.md をご覧いただき、プルリクエストを送信してください。
手順 6 – HTTP ヘッダーリストにヘッダーを追加する
- HTTP ヘッダーリファレンス概要ページで、ヘッダーが適切なカテゴリーにリストアップされていることを確認してください。
手順 7 — レビューを受ける
ページ作成後、プルリクエストとして提出すると、当社の審査担当者が自動的に割り当てられ、ページをレビューします。