如何添加词汇表条目
本文介绍如何添加和链接到 MDN Web Docs 词汇表 中的条目。它还提供了关于词汇表条目布局和内容的指南。词汇表提供了你在阅读 MDN 关于 Web 和 Web 开发的内容时遇到的所有术语、行话、缩写和首字母缩略词的定义。
由于 Web 始终在变化,词汇表可能永远不会完整。通过贡献新条目或修复问题,你可以帮助我们更新词汇表并填补空白。
为词汇表做贡献是让 Web 对每个人都更容易理解的一种简单方法。你不需要高水平的技术技能。词汇表条目应简洁明了。
如何撰写条目
首先,选择你想为其撰写词汇表条目的主题。如果你正在寻找需要词汇表条目的主题,请查看 词汇表登陆页 侧边栏中的术语列表。
写一个摘要
任何词汇表页面的第一个段落都是对术语的简单简短描述。最好不要超过两句话。确保读者能立即理解所定义的术语。
注意: 请不要从互联网上的其他定义或内容复制粘贴。(尤其不要从维基百科复制,因为其许可版本范围较小且与 MDN 不兼容。)你的词汇表条目应该是原创内容。
撰写一个好的词汇表条目
如果必须,可以添加几段额外的文字,但很容易就会写成一篇完整的文章。写文章是可以的,但请不要在词汇表中创建。如果你不确定文章应该放在哪里,请随时 联系我们讨论。
有一些简单的指南需要考虑,以便更好地撰写词汇表条目
- 当你在词汇表对术语的描述中使用术语或缩写时,你应该创建适当的链接。通常,这只是创建链接到词汇表中的其他页面。
- 在词汇表条目中使用适当的相关术语(带链接),前提是这样做不会使文章难以理解。拥有一个良好的相关且有用的链接网络可以使页面——或一组页面——更易于使用。
- 想想如果你想找到这个页面,你会选择哪些搜索词。尽量使用你搜索该术语时会使用的所有词语,但不要让词汇表条目变得无意义、冗长或难以阅读。
通过链接扩展
词汇表条目应始终以“另请参见”部分结束。此部分应包含链接,以帮助读者进一步了解:发现更多细节;学习使用相关技术。
将链接组织成三组是个好习惯
处理歧义
某些术语根据上下文可能有多种含义。为解决歧义,请遵循以下指南
- 术语的主页面必须是一个歧义页面,其中包含
GlossaryDisambiguation宏。 - 该术语具有子页面,用于定义不同上下文中的术语。
让我们用一个例子来说明。术语“签名”在至少两种不同上下文中可以有不同的含义:安全和函数。
- 页面 Glossary/Signature 是包含
GlossaryDisambiguation宏的歧义页面。 - 页面 Glossary/Signature/Security 是定义安全上下文中的签名的页面。
- 页面 Glossary/Signature/Function 是定义函数签名的页面。