如何在词汇表中编写条目

本文介绍了如何在 MDN Web 文档词汇表 中添加和链接条目。它还提供了有关词汇表条目布局和内容的指南。词汇表提供了您在阅读有关 Web 和 Web 开发的 MDN 内容时会遇到的所有术语、行话、缩写和首字母缩略词的定义。

由于 Web 始终在变化，词汇表可能永远不会完整。通过贡献新条目或修复问题，您可以帮助我们更新词汇表并填补空白。

为词汇表做出贡献是帮助使 Web 对每个人都更容易理解的一种简单方法。您不需要高级的技术技能。词汇表条目旨在简单明了。

如何编写条目

首先，选择您想为其编写词汇表条目的主题。如果您正在寻找需要词汇表条目的主题，请查看 词汇表首页 侧边栏中的术语列表。

如果您有新的词汇表条目的想法，请在 词汇表首页 下面为其创建一个新页面。

编写摘要

任何词汇表页面的第一段是对该术语的简单而简短的描述。最好不超过两句话。确保任何阅读描述的人都能立即理解定义的术语。

注意：请勿从互联网上的其他定义或内容复制粘贴。（尤其是维基百科，因为其许可版本范围较小且与 MDN 不兼容。）您的词汇表条目应为原创内容。

编写优秀的词汇表条目

如果必须，可以添加一些额外的段落，但很容易发现自己写了一整篇文章。写文章很好，但请不要在词汇表中/为词汇表创建它。如果您不确定将文章放在哪里，请随时联系我们讨论。

编写更好的词汇表条目需要考虑一些简单的指南

  • 当您在词汇表对术语的描述中使用术语或使用缩写时，您应该创建相应的链接。通常，这只需创建到词汇表中其他页面的链接。
  • 如果可以在不使文章难以理解的情况下，请在词汇表条目中使用相关的术语（带链接）。拥有良好的相关和有用链接网络使页面（或一组页面）更容易使用。
  • 考虑一下，如果您想查找此页面，您会选择哪些搜索词。尝试使用您用来搜索该术语的所有单词，但不要使词汇表条目毫无意义、冗长或难以阅读。

词汇表条目应始终以“另请参阅”部分结尾。本节应包含帮助读者前进的链接：发现更多详细信息；学习如何使用相关技术。

最好将链接组织成三组

一般知识

这些链接提供有关该术语或主题的更高级别信息。例如：到相关维基百科 页面的链接。

技术参考

这些链接在 MDN Web 文档或其他网站上提供深入的技术信息。

了解它

这些链接指向教程、练习、示例或任何其他有助于读者学习的教学内容。

处理歧义

某些术语根据上下文可能有多种含义。要解决歧义，请遵循以下指南

  • 术语的主页必须是包含 GlossaryDisambiguation 宏的歧义页面。
  • 该术语有子页面，用于在不同上下文中定义该术语。

让我们用一个例子来说明这一点。术语“签名”至少在两种不同的上下文中具有不同的含义：安全和函数。

  1. 页面 词汇表/签名 是包含 GlossaryDisambiguation 宏的歧义页面。
  2. 页面 词汇表/签名/安全 是在安全上下文中定义签名的页面。
  3. 页面 词汇表/签名/函数 是定义函数签名的页面。