寫作指南

MDN Web Docs 是一個開源專案。下面概述的各部分描述了我們關於在 MDN Web Docs 上記錄什麼內容以及如何記錄內容的指南。要了解如何貢獻,請參閱我們的貢獻指南

我們寫什麼

本節涵蓋了我們在 MDN Web Docs 上包含和不包含的內容,以及其他一些政策,例如何時撰寫關於新技術的內容、內容建議流程以及是否接受外部連結。如果您考慮為我們撰寫或更新內容,這是一個不錯的起點。

收錄標準

本文詳細介紹了 MDN Web Docs 上內容的收錄標準、收錄新文件的申請流程,以及申請方的期望和指南。

我們的寫作風格指南

寫作風格指南涵蓋了我們在 MDN Web Docs 上使用的語言和風格。它還涵蓋了如何格式化程式碼示例

學習 Web 開發寫作指南

MDN 的“學習 Web 開發”部分專門面向學習 Web 開發基本基礎知識的人員,因此需要與 MDN 的其他內容採取不同的方法。本文提供了編寫學習內容的指南。

如何為 MDN Web Docs 編寫內容

本節涵蓋了建立和編輯頁面的所有資訊,包括我們遵守的特定流程和技術。本節提供了關於入門的資訊、頁面結構的總體概述,以及在哪裡可以找到特定任務的操作方法。本節包括以下主題:

如何研究技術

本節提供了一些關於研究您要記錄的技術的實用技巧。

如何建立、移動和刪除頁面

本節解釋了我們如何在 MDN Web Docs 上建立、移動或刪除頁面。它還解釋了我們在移動或刪除頁面時如何重定向頁面。

如何使用 Markdown

我們使用的 Markdown 格式源自GitHub flavored markdown (GFM)。本節是關於我們在 MDN Web Docs 上使用的 Markdown 的指南,包括特定頁面內元件的格式,例如註釋和定義列表。

新增圖片和媒體

本節描述了在頁面中包含媒體(例如圖片)的要求。

如何記錄 CSS 屬性

本文介紹瞭如何編寫 CSS 屬性頁面,包括佈局和內容。

如何記錄 API 參考

本節解釋瞭如何著手記錄 Web API。

如何記錄 HTTP 標頭

本文介紹瞭如何為 HTTP 標頭建立新的參考頁面。

如何向詞彙表中新增條目

本文介紹瞭如何在 MDN Web Docs 詞彙表中新增和連結條目。它還提供了關於詞彙表條目佈局和內容的指南。

MDN Web Docs 上的頁面型別

MDN Web Docs 上的每個頁面都有特定的頁面型別,無論是 CSS 參考頁面還是 JavaScript 指南頁面。本節列出了不同的頁面型別併為每種型別提供了模板。瀏覽這些內容以瞭解您要編寫的頁面型別是個好主意。

MDN Web Docs 上的頁面結構

本節涵蓋了我們用於在 MDN Web Docs 上提供一致資訊呈現的各種頁面結構。這包括

語法部分

MDN Web Docs 參考頁面的語法部分包含一個語法框,用於定義功能的精確語法。本文介紹瞭如何為參考文章編寫語法框。

程式碼示例

有許多不同的方法可以在頁面中包含程式碼示例。本節概述了它們,併為不同語言提供了語法指南。

橫幅和通知

有時,一篇文章需要新增特殊通知。如果頁面涵蓋了已棄用的技術或其他不應在生產程式碼中使用的材料,則可能會發生這種情況。本文介紹了最常見的情況以及如何處理它們。

規範表格

MDN Web Docs 上的每個參考頁面都應提供有關定義該 API 或技術的規範的資訊。本文演示了這些表格的外觀,並解釋瞭如何新增它們。

相容性表

MDN Web Docs 為我們的開放 Web 文件提供了相容性表的標準格式。本文介紹瞭如何向用於生成相容性表的資料庫新增內容和維護該資料庫,以及如何將表格整合到文章中。

宏是頁面中用於生成內容(例如側邊欄)的快捷方式。本節列出了我們使用的宏及其功能。

描述了我們關於在網上其他地方使用 MDN Web Docs 內容的政策,如何獲得在 MDN 上重新發布內容的許可,以及連結到 MDN 內容的提示。

如何標記技術

本節涵蓋了我們對“已淘汰”、“已棄用”和“實驗性”等術語的定義,並提供瞭如何用這些術語標記技術的指南,以及何時從 MDN Web Docs 中刪除內容的指南。