MDN Web Docs 內容收錄標準

Web 標準技術

MDN Web Docs 的宗旨是記錄在可靠的標準機構釋出的規範中、並且至少在一個穩定瀏覽器中得到支援的 Web 標準技術。這些標準表明了 Web 行業對該技術的足夠興趣、穩定性和“實現意向”。因此，我們認為這些技術值得我們花費時間和精力去記錄。過早記錄一項 Web 技術或功能可能會因缺乏興趣而被取消，或者可能不穩定而發生重大變化，這將不必要地導致大量重寫（我們儘量避免這種情況）。

非 Web 標準技術

非 Web 標準技術是指不符合上述標準的那些技術。我們通常不會考慮將其收錄在 MDN Web Docs 中。

我們的使命是“為開發者提供輕鬆構建開放 Web 專案所需的資訊”。這表明我們應該考慮記錄對 Web 開發者有用的技術，即使它們不是開放 Web 標準、處於標準軌道上等。

如果您希望考慮將非 Web 標準技術收錄到 MDN Web Docs 中，您應確保它符合以下標準。

技術名稱、核心用途/用例以及目標開發者受眾。
圍繞該技術有哪些行業或社群的關注度？
- 是否有大量 Web 開發者在使用它？行業採納情況如何？
- 是否有大量 Web 開發者想要或需要這些資訊？
- 此資訊的目標受眾規模有多大？如果可能，請提供支援性統計資料。
該技術與核心 Web 技術和 Web 瀏覽器有何關聯？有用的細節包括：
- 是否使用 HTML 和 CSS，但通常不輸出到 Web？
- 是否透過 polyfill 在 Web 瀏覽器中得到支援？
目前有哪些文件或資源涵蓋該技術？
需要在 MDN Web Docs 中新增多少文件？
- 列出預期的指南、教程、元素/方法/屬性參考頁等的數量。
- 提供一個高層級的目錄。
- 提及您認為此資源除了基礎文件頁面外，可能還需要包含哪些“高階”功能？您是否期望包含嵌入式影片、互動式程式碼示例等？
誰將編寫文件？他們是誰，為什麼適合這項工作？
文件將如何維護？

在此階段，您無需向我們提供數百頁的詳細資訊（事實上，我們更希望您不要這樣做）。對以上每一點進行幾段描述已經足夠。

注意： MDN Web Docs 主要是一個英文網站 (en-US)。您專案的主要語言應為美式英語。

等待回覆

我們將審閱技術和您在提案中提供的資訊，並回復以下答案之一：

否：我們認為它不符合在 MDN Web Docs 中記錄的標準。
可能：我們不確定它是否適合在 MDN Web Docs 中記錄，並希望提出一些進一步的問題。
是：我們認為將其收錄到 MDN Web Docs 中是合適的。

如果該技術是一個好的人選，團隊將協助您開始編寫文件。

記錄新技術的專案指南

如果您的選定技術已被接受在 MDN Web Docs 中進行記錄，下一步就是開始。

為了確保您在 MDN Web Docs 中記錄新技術的專案成功，我們需要您具備以下條件：

專門的團隊
專案計劃和路線圖
寫作指南和標準
直觀的文件結構
維護計劃

專門的團隊

請確保您有一個專門的團隊，負責編寫初始文件並進行未來的維護和更新。

請考慮工作量以及您可能需要多少人。

如果這是一個大型專案，您可能需要幾名作者、一名技術審閱員來檢查技術準確性、一名編輯來潤色語言、一名程式碼示例編寫者等等。
在一個小型專案中，您可能只需要一兩個人承擔多個角色。您如何組建團隊都可以，只要適合您即可。

MDN Web Docs 團隊將為您分配一名成員，負責提供 MDN Web Docs 方面的指導。

您應指定一到兩名團隊負責人，他們可以與 MDN Web Docs 團隊成員進行溝通。

MDN Web Docs 代表將協助為您的團隊成員獲取在 GitHub 上的 MDN 組織中工作的必要許可權。

專案計劃和路線圖

為專案建立計劃——任務、預計完成日期以及您想要跟蹤以確保穩步進展的里程碑。

如果專案很大，您應該考慮指定一名團隊成員擔任專案經理。您還應該考慮為初始釋出編寫一個子專案計劃，該計劃包含可釋出的最低限度文件（一個最小可行產品）；之後您可以進行進一步的補充。

如果文件專案很小，您仍然需要記錄已完成和未完成的工作，每部分文件所處的階段（例如，未開始、進行中、草稿已寫、已審閱、完成），以及誰在做什麼。

寫作指南和標準

這些指南說明了我們期望 MDN Web Docs 文件的編寫方式。

如果您有關於您正在編寫的文件的額外指南，我們希望此指南能夠得到補充並保持更新。

在標準方面，您需要保持合理的寫作質量，以使您的文件能夠保留在 MDN Web Docs 上。您的 MDN Web Docs 代表將與您合作，明確您需要做什麼。

直觀的文件結構

如果您已經完成了提案提交過程，那麼您應該已經對要為這項技術編寫的內容有了一個大致的輪廓。此時，您應該將其細化為一個站點結構計劃：考慮文件層次結構是什麼，以及所有內容將如何放置和連結在一起。

每個專案都不同，但我們建議以下目錄結構：

├── Guides
│   ├── guide_one
│   ├── guide_two
│   └── index.md
├── index.md
├── Reference
│   ├── Elements
│   ├── Methods
│   ├── Others ?
│   └── index.md
└── Tutorials
    ├── tutorial_one
    ├── tutorial_two
    └── index.md

您的專案中將使用的每種頁面型別都應有一個頁面模板供他人複製結構。您應該儘早決定這些。

請參閱我們關於頁面型別的部分。如果需要進行新增，請與您的 MDN Web Docs 代表聯絡。

維護計劃

此技術的文件需要進行維護才能保留在 MDN Web Docs 上。

MDN Web Docs 的內容和檔案儲存在 GitHub 上。當其他人更改您技術的文件時，您團隊的一名成員需要審查這些更改，以確保內容仍然良好。您可以透過 GitHub 的通知功能跟蹤開啟的拉取請求 (PR)。
當技術發生變化需要更新文件時，您的團隊需要進行適當的更新，並保持與原始文件相同的標準。

如果在六個月的期限內未觀察到積極的變化，並且文件出現以下任一狀態：

過時或未維護
停滯不前，未完成
質量低下
過時

那麼該技術的文件將被視為無效。在您的團隊和 MDN Web Docs 團隊代表討論後，文件將被刪除。

我們希望您能理解，我們在這些問題上需要嚴格——我們不能讓網站充斥著低質量、不完整或過時的文件。

幫助改進 MDN

瞭解如何貢獻

此頁面最後修改於 2025年3月19日，由 MDN 貢獻者。

在 GitHub 上檢視此頁面 • 報告此內容的錯誤

Web 標準技術

非 Web 標準技術