如何新增詞彙表條目
本文介紹如何新增和連結到 MDN Web Docs 詞彙表 中的條目。它還提供了關於詞彙表條目佈局和內容的指南。詞彙表提供了你在閱讀 MDN 關於 Web 和 Web 開發的內容時遇到的所有術語、行話、縮寫和首字母縮略詞的定義。
由於 Web 始終在變化,詞彙表可能永遠不會完整。透過貢獻新條目或修復問題,你可以幫助我們更新詞彙表並填補空白。
為詞彙表做貢獻是讓 Web 對每個人都更容易理解的一種簡單方法。你不需要高水平的技術技能。詞彙表條目應簡潔明瞭。
如何撰寫條目
首先,選擇你想為其撰寫詞彙表條目的主題。如果你正在尋找需要詞彙表條目的主題,請檢視 詞彙表登陸頁 側邊欄中的術語列表。
寫一個摘要
任何詞彙表頁面的第一個段落都是對術語的簡單簡短描述。最好不要超過兩句話。確保讀者能立即理解所定義的術語。
注意: 請不要從網際網路上的其他定義或內容複製貼上。(尤其不要從維基百科複製,因為其許可版本範圍較小且與 MDN 不相容。)你的詞彙表條目應該是原創內容。
撰寫一個好的詞彙表條目
如果必須,可以新增幾段額外的文字,但很容易就會寫成一篇完整的文章。寫文章是可以的,但請不要在詞彙表中建立。如果你不確定文章應該放在哪裡,請隨時 聯絡我們討論。
有一些簡單的指南需要考慮,以便更好地撰寫詞彙表條目
- 當你在詞彙表對術語的描述中使用術語或縮寫時,你應該建立適當的連結。通常,這只是建立連結到詞彙表中的其他頁面。
- 在詞彙表條目中使用適當的相關術語(帶連結),前提是這樣做不會使文章難以理解。擁有一個良好的相關且有用的連結網路可以使頁面——或一組頁面——更易於使用。
- 想想如果你想找到這個頁面,你會選擇哪些搜尋詞。儘量使用你搜索該術語時會使用的所有詞語,但不要讓詞彙表條目變得無意義、冗長或難以閱讀。
透過連結擴充套件
詞彙表條目應始終以“另請參見”部分結束。此部分應包含連結,以幫助讀者進一步瞭解:發現更多細節;學習使用相關技術。
將連結組織成三組是個好習慣
處理歧義
某些術語根據上下文可能有多種含義。為解決歧義,請遵循以下指南
- 術語的主頁面必須是一個歧義頁面,其中包含
GlossaryDisambiguation宏。 - 該術語具有子頁面,用於定義不同上下文中的術語。
讓我們用一個例子來說明。術語“簽名”在至少兩種不同上下文中可以有不同的含義:安全和函式。
- 頁面 Glossary/Signature 是包含
GlossaryDisambiguation宏的歧義頁面。 - 頁面 Glossary/Signature/Security 是定義安全上下文中的簽名的頁面。
- 頁面 Glossary/Signature/Function 是定義函式簽名的頁面。