步驟 1 – 確定要記錄的 HTTP 標頭
- IETF 標準中定義了許多 HTTP 標頭。
- IANA 維護著一個HTTP 標頭欄位登錄檔,維基百科列出了已知的標頭欄位,但並非所有標頭都與 Web 開發人員相關,也不是所有標頭都是官方標準的一部分。
- 如果當前HTTP 標頭參考總覽頁面上有任何紅色連結,那麼這些標頭都是很好的記錄物件。
- 如有疑問,請諮詢 MDN Web Docs 團隊,瞭解是否值得為所選標頭撰寫文件。
步驟 2 – 檢查現有的 HTTP 標頭頁面
步驟 3 – 建立 HTTP 標頭頁面
- 所有標頭頁面都位於此目錄下:
files/en-us/web/http/reference/headers - 要建立新頁面,請參閱我們如何建立頁面指南中的說明。
步驟 4 – 編寫內容
- 您可以從我們的模板 HTTP 標頭頁面開始,或者使用您在步驟 2 中找到的現有 HTTP 標頭文件之一的複製結構。這取決於您。
- 編寫新的 HTTP 標頭文件。
- 確保您包含以下部分:
- 導語,其中第一句話應包含標頭名稱(加粗)並概述其用途。
- 資訊框,至少包含標頭型別以及該標頭是否為禁止的請求標頭。
- 語法框,包含 HTTP 標頭所有可能的指令/引數/值。
- 一個解釋這些指令/值的章節。
- 一個示例章節,其中包含該標頭的實際用例,或展示它通常在何處以及如何出現。
- 一個列出相關 RFC 標準文件的規範章節。
- 一個列出相關資源的“另請參閱”章節。
步驟 5 – 新增瀏覽器相容性資訊
- 如果您查看了其他 HTTP 標頭頁面,您會發現有一個 `{{Compat}}` 宏,它可以為您填充瀏覽器相容性表格。
- 相容性表格頁面是從結構化資料生成的。如果您想為資料做出貢獻,請檢視 https://github.com/mdn/browser-compat-data/blob/main/README.md 上的說明,併發送一個 pull request 給我們。
步驟 6 – 更新 HTTP 標頭列表
確保您的標頭已列在HTTP 標頭參考總覽頁面的相應類別下。
步驟 7 – 獲取內容稽核
建立標頭頁面後,提交一個 pull request。我們的稽核團隊的一名成員將被自動分配來稽核您的頁面。