我們寫什麼
MDN Web Docs 包含瀏覽器無關的文件,使 Web 開發人員能夠編寫瀏覽器通用的程式碼。在本文中,您將找到有關給定主題和/或內容型別是否應包含在 MDN Web Docs 中的資訊。
編輯政策
本節描述了 Mozilla MDN 員工制定的用於管理 MDN Web Docs 上內容的政策。MDN Web Docs 的所有貢獻者都應遵守這些政策。
相關性
MDN Web Docs 上的所有內容必須與其出現的相應技術部分相關。垃圾郵件(商業廣告)和其他不相關的內容將永遠不會被接受到網站上。試圖提交垃圾郵件的貢獻者可能會被 MDN 酌情禁止,由 Mozilla MDN 員工決定。
到與主題相關的商業網站的出站連結將根據具體情況進行判斷。它們在幫助 Web 開發人員方面的價值必須超過連結網站的商業利益。
注意:您將在 MDN 的《學習 Web 開發》部分看到指向商業網站的連結,但這些連結使用得非常少,並且我們只連結到值得信賴的教育合作伙伴。您可以在《學習 Web 開發》寫作指南 > 合作伙伴連結和嵌入中閱讀更多相關資訊。
中立性
MDN Web Docs 上的文章必須保持中立的觀點,客觀地報告瀏覽器差異,不受編輯偏見的影響。任何關於任何瀏覽器或使用者代理的貶低性評論都是不可接受的。
標準化
應在 MDN Web Docs 上記錄的 Web 技術應處於標準化軌道上,並且必須由至少一個渲染引擎實現。瀏覽器支援的差異將在文章的瀏覽器相容性部分進行記錄。
建議內容
如果您想為 MDN Web Docs 建議內容,請確保您在提交之前閱讀了本頁,以確保您建議的內容是合適的。
對於新的參考頁面或指南,請開啟一個新問題,概述您建議的內容以及原因(請儘可能具體)。
對於建議涉及新內容部分的較大專案,請參考收錄標準頁面,該頁面也概述了申請流程。
應在 MDN Web Docs 中討論的主題
總的來說,如果這是一項開放的 Web 技術,我們就會在 MDN Web Docs 上對其進行記錄。這包括現在和不久的將來可供 Web 開發人員用來建立網站和應用程式的任何功能。
如果一項功能由多個瀏覽器實現,並且已被接受為標準或正在朝著標準化方向發展,那麼是的,我們肯定會在這裡記錄它。如果一項功能仍然非常實驗性,並且沒有在多個瀏覽器中實現,以及/或者容易發生變化,那麼它仍然適合收錄,但可能不會被寫作團隊視為優先事項。
換句話說,應在 MDN Web Docs 上記錄的 Web 技術應滿足以下所有標準
- 處於標準化軌道上。
- 已由可靠的標準機構釋出。
- 已由至少一個渲染引擎實現。
- 已在穩定版本的瀏覽器中釋出。
我們的主要關注點是編寫以下前端 Web 技術
我們也記錄了一些更廣泛的主題,例如SVG、XML、WebAssembly 和可訪問性。此外,我們還為這些技術提供了廣泛的學習指南和術語表。
注意:後端技術通常有自己的文件,MDN Web Docs 不會試圖取代它們,儘管我們有一些例外。
MDN Web Docs 上的所有內容必須與其出現的相應技術部分相關。貢獻者應遵循這些MDN 寫作指南,以獲取寫作風格、程式碼示例和其他主題。
有關技術是否可以記錄在 MDN Web Docs 上的標準的更多詳細資訊,請參閱收錄標準頁面。
當我們記錄一項新技術時
在 MDN Web Docs 上,我們一直在酌情記錄新的 Web 標準技術。我們試圖在足夠早地釋出文件,以便開發人員一旦需要就能瞭解新功能,並在足夠晚的時候釋出文件,以便技術成熟穩定,這樣文件就不需要頻繁更新或快速刪除。
總的來說,我們認為最早考慮記錄一項新技術的時間是:當該功能處於標準化軌道上並且已在某個地方實現時。
我們考慮記錄一項新技術,如果它
- 已由可靠的標準組織(如 W3C、WHATWG、Khronos、IETF 等)釋出並達到合理穩定水平(例如,W3C 工作草案或候選推薦,或當規範從其問題流中看起來相當穩定時),並且
- 已在至少一個瀏覽器中一致實現,並且其他瀏覽器開發人員表現出興趣(例如,已有一個活動的票證或正在執行“意向實現”流程)。
我們不記錄新技術,如果
- 它沒有規範,或者規範是一份粗略的、可能發生變化的筆記,
- 目前只有一到零個瀏覽器實現了它,並且不支援的瀏覽器沒有表現出實現它的興趣。您可以透過詢問這些瀏覽器的工程師以及檢視瀏覽器錯誤跟蹤器和郵件列表等來衡量這一點,
- 不是 Web 暴露的技術,以及/或者完全是專有的,或者
- 它已經表現出被棄用或被類似功能取代的跡象。
不應在 MDN Web Docs 中討論的主題
總的來說,任何不是開放 Web 標準的東西都不應該出現在 MDN Web Docs 上。垃圾郵件(商業廣告)和其他不相關的內容將永遠不會被接受到網站上。試圖提交垃圾郵件的貢獻者可能會被 MDN 酌情禁止,由 Mozilla MDN 員工決定。
MDN Web Docs 上不合適的主題示例包括
- 未暴露給 Web 且特定於瀏覽器的技術。
- 與 Web 無關的技術。
- 面向終端使用者的文件。例如,對於 Mozilla 產品,此類文件應放在Mozilla 支援網站上。
- 自我連結或自我推廣的外部連結。在新增外部連結之前,請檢視我們寫作風格指南中的這些指南。
我們何時刪除文件
當頁面不再包含任何有用的資訊、過於過時,以及/或者可能不正確到可能產生誤導時,就會從 MDN Web Docs 中刪除。
以下示例描述了可能刪除頁面/內容的幾種情況
- 文章包含有關尚未在所有瀏覽器中實現但後來被撤回的功能的資訊(通常是實驗性功能,如字首功能)。
- 參考頁面描述了在任何瀏覽器中實現之前就已從規範中刪除的功能。
- 文章涵蓋的技術後來被證明是糟糕的做法,並被更好的技術所取代。
- 文章包含的資訊後來被其他更高質量的文章所取代。
- 文章包含不適合 MDN Web Docs 的內容。
- MDN Web Docs 的某些部分不專注於開放 Web 技術,並且維護負擔沉重。
有關如何刪除文件的更多資訊,請參閱建立、移動和刪除頁面指南。
允許在 MDN Web Docs 中使用的文件型別
通常,我們的文件分為以下幾類
- 參考
- 指南
- 術語表
- 學習/教程
總的來說,MDN Web Docs 是用於產品文件,而不是專案或流程文件。因此,如果文件是關於“如何使用某物”或“某物如何工作”(其中,“某物”位於上述主題類別之一),那麼它可以放在 MDN Web Docs 上。
如果文件是關於“誰在開發某物”或“開發某物的計劃”,那麼它不應該放在 MDN Web Docs 上。
以下是一些不應放在 MDN Web Docs 上的文件型別示例
- 計劃文件
- 設計文件
- 專案提案
- 規範或標準
- 宣傳材料、廣告或個人資訊