撰寫指南
MDN Web Docs 是一個開源專案。以下各章節說明了我們在 MDN Web Docs 上紀錄什麼以及如何紀錄的指南。若要了解如何貢獻,請參閱我們的貢獻指南。
- 我們撰寫的內容
-
本章節涵蓋我們在 MDN Web Docs 上包含哪些內容、不包含哪些內容,以及其他多項政策,例如何時撰寫新技術、內容建議流程,以及我們是否接受外部連結。如果你正在考慮為我們撰寫或更新內容,這是一個很好的起點。本章節還包括:
- 納入標準
-
詳細說明了 MDN Web Docs 中納入內容的標準、新文件加入申請流程,以及申請方的期望和指南。
- 我們的寫作風格指南
-
寫作風格指南涵蓋了我們在 MDN Web Docs 上使用的語言和風格,還包括如何格式化程式碼範例。
- 如何為 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 對開放網路文件的相容性表格有標準格式。本文說明如何添加和維護生成相容性表格的資料庫,以及如何將表格整合到文章中。
- 巨集
-
巨集是用於生成頁面內容的捷徑,例如側邊欄。本章節列出了我們使用的巨集及其功能。
- 署名與著作權許可資訊
-
說明如何在其他網站上使用 MDN Web Docs 內容、如何獲得重新發布 MDN 內容的許可,以及連結到 MDN 內容的提示。
- 如何標記技術
-
本章節說明過時、棄用和實驗性術語的定義,並提供標記技術的指南,以及何時從 MDN Web Docs 中移除內容。