我们写什么

MDN Web Docs 包含浏览器无关的文档,使 Web 开发人员能够编写浏览器通用的代码。在本文中,您将找到有关给定主题和/或内容类型是否应包含在 MDN Web Docs 中的信息。

编辑政策

本节描述了 Mozilla MDN 员工制定的用于管理 MDN Web Docs 上内容的政策。MDN Web Docs 的所有贡献者都应遵守这些政策。

相关性

MDN Web Docs 上的所有内容必须与其出现的相应技术部分相关。垃圾邮件(商业广告)和其他不相关的内容将永远不会被接受到网站上。试图提交垃圾邮件的贡献者可能会被 MDN 酌情禁止,由 Mozilla MDN 员工决定。

到与主题相关的商业网站的出站链接将根据具体情况进行判断。它们在帮助 Web 开发人员方面的价值必须超过链接网站的商业利益。

注意:您将在 MDN 的《学习 Web 开发》部分看到指向商业网站的链接,但这些链接使用得非常少,并且我们只链接到值得信赖的教育合作伙伴。您可以在《学习 Web 开发》写作指南 > 合作伙伴链接和嵌入中阅读更多相关信息。

中立性

MDN Web Docs 上的文章必须保持中立的观点,客观地报告浏览器差异,不受编辑偏见的影响。任何关于任何浏览器或用户代理的贬低性评论都是不可接受的。

标准化

应在 MDN Web Docs 上记录的 Web 技术应处于标准化轨道上,并且必须由至少一个渲染引擎实现。浏览器支持的差异将在文章的浏览器兼容性部分进行记录。

建议内容

如果您想为 MDN Web Docs 建议内容,请确保您在提交之前阅读了本页,以确保您建议的内容是合适的。

对于新的参考页面或指南,请打开一个新问题,概述您建议的内容以及原因(请尽可能具体)。

对于建议涉及新内容部分的较大项目,请参考收录标准页面,该页面也概述了申请流程。

应在 MDN Web Docs 中讨论的主题

总的来说,如果这是一项开放的 Web 技术,我们就会在 MDN Web Docs 上对其进行记录。这包括现在和不久的将来可供 Web 开发人员用来创建网站和应用程序的任何功能。

如果一项功能由多个浏览器实现,并且已被接受为标准或正在朝着标准化方向发展,那么是的,我们肯定会在这里记录它。如果一项功能仍然非常实验性,并且没有在多个浏览器中实现,以及/或者容易发生变化,那么它仍然适合收录,但可能不会被写作团队视为优先事项。

换句话说,应在 MDN Web Docs 上记录的 Web 技术应满足以下所有标准

  • 处于标准化轨道上。
  • 已由可靠的标准机构发布。
  • 已由至少一个渲染引擎实现。
  • 已在稳定版本的浏览器中发布。

我们的主要关注点是编写以下前端 Web 技术

我们也记录了一些更广泛的主题,例如SVGXMLWebAssembly可访问性。此外,我们还为这些技术提供了广泛的学习指南术语表

注意:后端技术通常有自己的文档,MDN Web Docs 不会试图取代它们,尽管我们有一些例外

MDN Web Docs 上的所有内容必须与其出现的相应技术部分相关。贡献者应遵循这些MDN 写作指南,以获取写作风格、代码示例和其他主题。

有关技术是否可以记录在 MDN Web Docs 上的标准的更多详细信息,请参阅收录标准页面。

当我们记录一项新技术时

在 MDN Web Docs 上,我们一直在酌情记录新的 Web 标准技术。我们试图在足够早地发布文档,以便开发人员一旦需要就能了解新功能,并在足够晚的时候发布文档,以便技术成熟稳定,这样文档就不需要频繁更新或快速删除。

总的来说,我们认为最早考虑记录一项新技术的时间是:当该功能处于标准化轨道上并且已在某个地方实现时。

我们考虑记录一项新技术,如果它

  • 已由可靠的标准组织(如 W3C、WHATWG、Khronos、IETF 等)发布并达到合理稳定水平(例如,W3C 工作草案或候选推荐,或当规范从其问题流中看起来相当稳定时),并且
  • 已在至少一个浏览器中一致实现,并且其他浏览器开发人员表现出兴趣(例如,已有一个活动的票证或正在执行“意向实现”流程)。

我们不记录新技术,如果

  • 它没有规范,或者规范是一份粗略的、可能发生变化的笔记,
  • 目前只有一到零个浏览器实现了它,并且不支持的浏览器没有表现出实现它的兴趣。您可以通过询问这些浏览器的工程师以及查看浏览器错误跟踪器和邮件列表等来衡量这一点,
  • 不是 Web 暴露的技术,以及/或者完全是专有的,或者
  • 它已经表现出被弃用或被类似功能取代的迹象。

不应在 MDN Web Docs 中讨论的主题

总的来说,任何不是开放 Web 标准的东西都不应该出现在 MDN Web Docs 上。垃圾邮件(商业广告)和其他不相关的内容将永远不会被接受到网站上。试图提交垃圾邮件的贡献者可能会被 MDN 酌情禁止,由 Mozilla MDN 员工决定。

MDN Web Docs 上不合适的主题示例包括

  • 未暴露给 Web 且特定于浏览器的技术。
  • 与 Web 无关的技术。
  • 面向最终用户的文档。例如,对于 Mozilla 产品,此类文档应放在Mozilla 支持网站上。
  • 自我链接或自我推广的外部链接。在添加外部链接之前,请查看我们写作风格指南中的这些指南。

我们何时删除文档

当页面不再包含任何有用的信息、过于过时,以及/或者可能不正确到可能产生误导时,就会从 MDN Web Docs 中删除。

以下示例描述了可能删除页面/内容的几种情况

  • 文章包含有关尚未在所有浏览器中实现但后来被撤回的功能的信息(通常是实验性功能,如前缀功能)。
  • 参考页面描述了在任何浏览器中实现之前就已从规范中删除的功能。
  • 文章涵盖的技术后来被证明是糟糕的做法,并被更好的技术所取代。
  • 文章包含的信息后来被其他更高质量的文章所取代。
  • 文章包含不适合 MDN Web Docs 的内容。
  • MDN Web Docs 的某些部分不专注于开放 Web 技术,并且维护负担沉重。

有关如何删除文档的更多信息,请参阅创建、移动和删除页面指南。

允许在 MDN Web Docs 中使用的文档类型

通常,我们的文档分为以下几类

  • 参考
  • 指南
  • 术语表
  • 学习/教程

总的来说,MDN Web Docs 是用于产品文档,而不是项目流程文档。因此,如果文档是关于“如何使用某物”或“某物如何工作”(其中,“某物”位于上述主题类别之一),那么它可以放在 MDN Web Docs 上。

如果文档是关于“谁在开发某物”或“开发某物的计划”,那么它不应该放在 MDN Web Docs 上。

以下是一些不应放在 MDN Web Docs 上的文档类型示例

  • 计划文档
  • 设计文档
  • 项目提案
  • 规范或标准
  • 宣传材料、广告或个人信息