Skip to content

Commit

Permalink
[zh-tw]: add and update translation of documents under "writing_guide…
Browse files Browse the repository at this point in the history
…lines/howto"
  • Loading branch information
weixiang0815 committed Feb 16, 2025
1 parent 8f136e5 commit a82b03c
Show file tree
Hide file tree
Showing 10 changed files with 1,634 additions and 72 deletions.

Large diffs are not rendered by default.

Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
---
title: 如何撰寫 CSS 屬性文件
slug: MDN/Writing_guidelines/Howto/Document_a_CSS_property
l10n:
sourceCommit: 719645a32546d9e514ac530a5eb66aa4c26d4f51
---

隨著 [CSS](/zh-TW/docs/Web/CSS) 標準發展,屬性不斷推陳出新。MDN Web 文件上的 [CSS 參考文件](/zh-TW/docs/Web/CSS/Reference)需要跟上這個變化。本文提供逐步指南,說明如何建立 CSS 屬性參考頁面。

每個 CSS 屬性參考頁面都遵循相同架構,這有助於讀者更有效率地查找資訊,尤其當熟悉標準參考頁面格式後。

## 第一步——決定要記錄的屬性

首先,你得決定要撰寫的 CSS 屬性文件。也許你注意到某個頁面缺失,或是在我們的[問題清單](https://github.com/mdn/content/issues)看到闕漏內容的回報。若要查找該 CSS 屬性的詳細資訊,你需要參閱相關規範,例如 [W3C 規範](https://www.w3.org/Style/CSS/),或是針對 Gecko 或 Blink 這類渲染引擎中的非標準屬性所提出的錯誤報告。

> [!NOTE]
> 當參考 W3C 規範時,請務必使用**編輯草稿(Editor's Draft)**(可見左側紅色橫幅標示),而非已發布的版本(如 Working Draft)。編輯草稿通常更接近最終版本!
若發現實作與規範不符,歡迎反映到實作錯誤回報裡。這能歸因到以下幾種可能:

- 可能是實作中的錯誤(後續會提交修正錯誤的回報)。
- 可能是因為新規範的發布有所延遲。
- 可能是規範中的錯誤(若是這種情況,應提交一份規範錯誤回報)。

## 第二步——檢查 CSS 屬性資料庫

CSS 屬性的某些特性(例如語法或能否動畫化)會在多個頁面中提及,因此這些資訊會儲存在一個特定資料庫中。你在頁面中使用的巨集需要從該資料庫讀取屬性資訊,因此請先[確認該資訊是否存在](https://github.com/mdn/data/blob/main/docs/updating_css_json.md)

## 第三步——建立 CSS 屬性頁面

準備就緒了!現在我們能新增實際 CSS 屬性頁面。建立新 CSS 屬性頁面最簡單的方法是**複製**現有的 CSS 屬性頁面內容,然後針對新屬性修改內容。請參閱我們的[如何建立頁面指南](/zh-TW/docs/MDN/Writing_guidelines/Howto/Creating_moving_deleting)

建立參考頁面時,你需要新增**範例(Examples)**。請參考這篇[如何建立、編輯、移動或刪除頁面](/zh-TW/docs/MDN/Writing_guidelines/Page_structures/Live_samples)。請記住,你建立的是**單一屬性**的參考頁面,因此你新增的範例應該**獨立展示該屬性的運作方式**,而非整個規範的應用方式。例如,`list-style-type` 屬性的範例應展示不同屬性值的效果,而不是如何與其它屬性、偽類別或偽元素結合來產生華麗效果。如需更完整應用範例,應該撰寫教學或指南來展示更多內容。

## 第四步——交付審核

建立屬性頁面後,請提交為 Pull Request。一位審核團隊成員將自動被指派來審核你的頁面。
Original file line number Diff line number Diff line change
@@ -0,0 +1,56 @@
---
title: 如何撰寫 HTTP 訊息檔頭文件
slug: MDN/Writing_guidelines/Howto/Document_an_HTTP_header
l10n:
sourceCommit: 719645a32546d9e514ac530a5eb66aa4c26d4f51
---

[HTTP 訊息檔頭參考文件](/zh-TW/docs/Web/HTTP/Headers)紀錄了超文字傳輸協定([HTTP](/zh-TW/docs/Web/HTTP))中請求與回應訊息的標頭部分。

本文說明如何為 HTTP 訊息檔頭建立新的參考頁面。

## 第一步——決定要撰文的 HTTP 訊息檔頭

- 在各種 IETF 標準中定義了許多 HTTP 訊息檔頭(Header)。
- IANA 維護著一份 [HTTP 訊息檔頭欄位登錄表](https://www.iana.org/assignments/http-fields/http-fields.xhtml),維基百科則整理了 [HTTP 頭欄位](https://zh.wikipedia.org/wiki/HTTP头字段),但並非所有標頭都與網路開發者有關或屬於正式標準的一部分。
- 若目前的 [HTTP 訊息檔頭參考總覽頁面](/zh-TW/docs/Web/HTTP/Headers)上有**紅色連結**,這些標頭通常是值得撰寫文件的好選擇。
- 如有疑問,請[洽詢 MDN Web 文件團隊](/zh-TW/docs/MDN/Community/Communication_channels),確認你選的標頭是否值得撰寫文件。

## 第二步——檢查現有 HTTP 訊息檔頭頁面

- 現有 HTTP 訊息檔頭文件可到[此處](/zh-TW/docs/Web/HTTP/Headers)查閱。
- HTTP 訊息檔頭分為不同範疇:{{Glossary("Request header", "請求標頭")}}、{{Glossary("Response header", "回應標頭")}}以及{{Glossary("Representation header", "表示標頭")}}。
- 確認你要撰寫的標頭所屬範疇(請注意,有些標頭根據情境不同,可能同時為請求標頭與回應標頭)。
- 前往與其相同範疇的現有標頭參考頁面。

## 第三步——建立 HTTP 訊息檔頭頁面

- 所有標頭頁面皆存放於此目錄下:[`files/zh-TW/web/http/headers`](https://github.com/mdn/content/tree/main/files/zh-TW/web/http/headers)
- 若要建立新頁面,請參閱我們的[如何建立、編輯、移動或刪除頁面](/zh-TW/docs/MDN/Writing_guidelines/Howto/Creating_moving_deleting)

## 第四步——撰寫內文

- 你可以選擇從我們的 [HTTP 訊息檔頭範本頁面](/zh-TW/docs/MDN/Writing_guidelines/Page_structures/Page_types#http_header_reference_page)開始,或是複製第二步中找到的現有 HTTP 訊息檔頭文件架構。
- 撰寫關於新 HTTP 訊息檔頭的內容。
- 確保包含以下各個部分:

- **簡介**:第一句應提及標頭名稱(**加粗**),並簡要概述其用途。
- **資訊框**:至少應包含標頭類型,以及該標頭是否屬於{{Glossary("Forbidden header name", "禁用標頭名稱")}}。
- **語法區塊**:列出該 HTTP 訊息檔頭的所有可能指令、參數或可接受的值。
- **指令/值說明**:詳細解釋該標頭的指令與可用值。
- **範例**:提供該標頭的實際應用案例,或展示其通常出現的情境。
- **規範**:列出相關的 RFC 標準文件。
- **相關連結**:「參見」區段,列出相關資源與參考資料。

## 第五步——加入瀏覽器相容性資訊

- 若你看過其它 HTTP 訊息檔頭頁面,就會發現有個 `\{{Compat}}` 巨集能自動填入瀏覽器相容性表格。
- 瀏覽器相容性表格是根據結構化資料生成的。若你有意貢獻這些資料,請參閱[相關說明](https://github.com/mdn/browser-compat-data/blob/main/README.md)並提交 Pull Request。

## 第六步——更新 HTTP 訊息檔頭清單

請確保你的標頭已列在 [HTTP 訊息檔頭參考總覽頁面](/zh-TW/docs/Web/HTTP/Headers)的合適範疇裡。

## 第七步——交付審核

建立屬性頁面後,請提交為 Pull Request。一位審核團隊成員將自動被指派來審核你的頁面。
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
---
title: 如何撰寫網路錯誤文件
slug: MDN/Writing_guidelines/Howto/Document_web_errors
l10n:
sourceCommit: 719645a32546d9e514ac530a5eb66aa4c26d4f51
---

[JavaScript 錯誤參考文件](/zh-TW/docs/Web/JavaScript/Reference/Errors)是 MDN Web 文件的一個專案,旨在幫助網路開發者解決[開發者主控台](https://firefox-source-docs.mozilla.org/devtools-user/web_console/index.html)中出現的錯誤。為推動專案,我們需要在 MDN Web 文件上撰寫更多網路錯誤文件,以便新增更多錯誤訊息來源工具的相關連結。本文說明如何撰寫網路錯誤文件。

JavaScript 錯誤訊息中包含一個「了解更多」的連結,點擊後會導向 JavaScript 錯誤參考文件,提供更多修正問題的建議。若要撰寫這些網路錯誤文件,你需要具備 JavaScript 知識,或至少能夠深入研究 [JavaScript](/zh-TW/docs/Web/JavaScript) 相關內容。

## 第一步——決定要撰寫的網頁錯誤

- [Firefox/Gecko 錯誤訊息](https://github.com/mozilla/gecko-dev/blob/master/js/src/jsshell.msg)
- [Chrome/V8 錯誤訊息](https://chromium.googlesource.com/v8/v8.git/+/refs/heads/main/src/execution/messages.h)

## 第二步——檢查現有的網頁錯誤文件

- 查看現有的 [JavaScript 錯誤參考文件](/zh-TW/docs/Web/JavaScript/Reference/Errors),了解網路錯誤的文件架構及撰寫方式。
- 根據你想撰寫的錯誤類型,進一步參考相關頁面內容。
- 你可以複製現有頁面的內容再行修改。

## 第三步——建立新的網頁錯誤頁面

- 所有網路錯誤頁面皆存放於此目錄下:[/docs/Web/JavaScript/Reference/Errors](/zh-TW/docs/Web/JavaScript/Reference/Errors)
- 若要建立新頁面,請參閱我們的[如何建立、編輯、移動或刪除頁面](/zh-TW/docs/MDN/Writing_guidelines/Howto/Creating_moving_deleting)

## 第四步——記錄網路錯誤

- 你可以選擇**複製**現有錯誤文件的架構,或是**從頭開始撰寫**
- 你的文件應至少包含:

- **語法區塊**:列出錯誤訊息在不同瀏覽器中顯示的方式。
- **錯誤類型**
- **錯誤原因及影響**:解釋為何發生此錯誤及可能影響;請在錯誤訊息內容之上進一步說明。
- **範例**:展示觸發錯誤的實際案例(可能有多種情境),並提供修正該錯誤的正確寫法範例。
- **相關參考資料**:提供 MDN Web 文件上其它相關內容連結,方便讀者進一步查閱。

## 第五步——交付審核

建立屬性頁面後,請提交為 Pull Request。一位審核團隊成員將自動被指派來審核你的頁面。
Loading

0 comments on commit a82b03c

Please sign in to comment.