我们致力于编写关于开放网络的最佳文档。这是一项巨大的任务,但我们的文档每天都在改进。 JavaScript 已被认为是一种极好的资源,我们的 CSS 参考 现在也已经相当完善,并且我们投入了大量精力到 HTML、SVG 和 MathML 文档的编写中。
我们的开放网络文档面向 Web 开发人员:我们希望它对您有用。为了实现这一点,我们遵循以下几个原则
- MDN 开放网络文档必须是 *浏览器无关* 的。作为一名 Web 开发人员,您正在为所有人编写网站。您不是为特定浏览器设计的。仅限 Gecko 的文档几乎毫无用处。因此,大约一年前,我们开始致力于使我们的文档独立于浏览器。我们离完成还很远,但已经取得了巨大的进步。
- 我们的文档必须是 *实用* 的。我们正在记录当今的 Web,而不是过去或未来的 Web。我们根据标准所说的内容撰写文章,无论标准是否完整或仍在开发中,并且我们会指出任何实现差异。
- 我们的文档适合 *不同水平* 的开发者。我们为初学者提供 教程,为中级用户提供更多 描述性文章,以及为经验丰富的开发者提供 参考文章。
- 我们保持文档 *最新*。这是我们最具挑战性的目标之一:过时的文章毫无用处。因此,我们每天都会关注标准的制定以及实现的改进。由于多个浏览器供应商采用了快速的发布周期,标准支持得到了快速改进,但我们的工作量也随之增加。(我们对此感到高兴!)
由于基于这些原则的辛勤工作,我们看到读者数量稳步增长。对我们来说,这是最好的回报。
帮助我们
我们经常收到关于如何帮助我们的问题。撰写新内容(在 文档冲刺 或任何其他时间),更正错别字,编写示例或翻译文章都是改进文档的好方法。但并非每个人都有时间或知识。
您还可以通过链接来帮助我们:从您的博客中 **链接到我们**,无论是在上下文中还是在侧边栏提及。这将使我们获得更多关注,吸引更多编辑,并帮助我们实现提供关于开放网络的准确和完整文档的目标。
为了帮助您,我们现在编写了一个简短的 链接指南,其中提供了有关如何以与 *您的读者* 相关的方式链接到 MDN 的提示和信息。
因此,请不要犹豫,链接到我们的技术入口页面(例如 CSS 页面)或非常具体的页面。但不要忘记基本规则:您正在为您的用户添加链接,您选择的链接应该帮助他们快速找到准确的信息。因为您的读者才是重要的人,而不是我们,也不是您。
使之成为一种简单习惯的一种方法是:每次您撰写关于开放网络技术的博客文章时,花五分钟时间考虑一下,添加一个或另一个链接到 MDN 是否会改进您的文章。如果可以,请添加这些链接!
这样,我们就能共同改进现有的开放网络文档。非常感谢您的支持。
关于 Jean-Yves Perrier
Jean-Yves 是 Mozilla 开发者推广团队的项目经理。在此之前,他是一名 MDN 技术作家,专门从事 Web 平台技术(HTML、CSS、API),并且担任了多年的 MDN 内容负责人。
14 条评论