帮助 MDN:链接到我们?

我们致力于编写关于开放网络的最佳文档。这是一项巨大的任务,但我们的文档每天都在改进。 JavaScript 已被认为是一种极好的资源,我们的 CSS 参考 现在也已经相当完善,并且我们投入了大量精力到 HTMLSVGMathML 文档的编写中。

我们的开放网络文档面向 Web 开发人员:我们希望它对您有用。为了实现这一点,我们遵循以下几个原则

  • MDN 开放网络文档必须是 *浏览器无关* 的。作为一名 Web 开发人员,您正在为所有人编写网站。您不是为特定浏览器设计的。仅限 Gecko 的文档几乎毫无用处。因此,大约一年前,我们开始致力于使我们的文档独立于浏览器。我们离完成还很远,但已经取得了巨大的进步。
  • 我们的文档必须是 *实用* 的。我们正在记录当今的 Web,而不是过去或未来的 Web。我们根据标准所说的内容撰写文章,无论标准是否完整或仍在开发中,并且我们会指出任何实现差异。
  • 我们的文档适合 *不同水平* 的开发者。我们为初学者提供 教程,为中级用户提供更多 描述性文章,以及为经验丰富的开发者提供 参考文章
  • 我们保持文档 *最新*。这是我们最具挑战性的目标之一:过时的文章毫无用处。因此,我们每天都会关注标准的制定以及实现的改进。由于多个浏览器供应商采用了快速的发布周期,标准支持得到了快速改进,但我们的工作量也随之增加。(我们对此感到高兴!)

由于基于这些原则的辛勤工作,我们看到读者数量稳步增长。对我们来说,这是最好的回报。

帮助我们

我们经常收到关于如何帮助我们的问题。撰写新内容(在 文档冲刺 或任何其他时间),更正错别字,编写示例或翻译文章都是改进文档的好方法。但并非每个人都有时间或知识。

您还可以通过链接来帮助我们:从您的博客中 **链接到我们**,无论是在上下文中还是在侧边栏提及。这将使我们获得更多关注,吸引更多编辑,并帮助我们实现提供关于开放网络的准确和完整文档的目标。

为了帮助您,我们现在编写了一个简短的 链接指南,其中提供了有关如何以与 *您的读者* 相关的方式链接到 MDN 的提示和信息。

因此,请不要犹豫,链接到我们的技术入口页面(例如 CSS 页面)或非常具体的页面。但不要忘记基本规则:您正在为您的用户添加链接,您选择的链接应该帮助他们快速找到准确的信息。因为您的读者才是重要的人,而不是我们,也不是您。

使之成为一种简单习惯的一种方法是:每次您撰写关于开放网络技术的博客文章时,花五分钟时间考虑一下,添加一个或另一个链接到 MDN 是否会改进您的文章。如果可以,请添加这些链接!

这样,我们就能共同改进现有的开放网络文档。非常感谢您的支持。

关于 Jean-Yves Perrier

Jean-Yves 是 Mozilla 开发者推广团队的项目经理。在此之前,他是一名 MDN 技术作家,专门从事 Web 平台技术(HTML、CSS、API),并且担任了多年的 MDN 内容负责人。

Jean-Yves Perrier 的更多文章……


14 条评论

  1. Jay

    是的,我还没有这样做。

    我的博客右侧栏有一个横幅(http://The4thDimension.net/)指向 Mozilla 的文档。

    2012 年 3 月 15 日 01:27

    1. Jean-Yves Perrier

      酷。谢谢。

      2012 年 3 月 15 日 03:50

  2. Joris

    我一直觉得 MDN 对 Mozilla 来说是特定的(我使用 MDN 已经有一段时间了)。很高兴看到这方面越来越多的改进。

    2012 年 3 月 15 日 03:38

    1. Jean-Yves Perrier

      是的,但仍然有一些文章存在明显的偏见。但我们试图一点一点地修复它们,即使有时很难找到关于其他引擎真正支持什么的可靠信息。

      2012 年 3 月 15 日 03:49

  3. Paul

    只想说声非常感谢您做这些。这些文档对我非常有帮助(我甚至为此设置了一个系统级快捷方式,以便在有任何问题时启动 MDN),并且它们正在扩展为完全浏览器无关,这真是太棒了。

    向你们致敬!:D

    2012 年 3 月 15 日 04:09

  4. Dave

    喜欢 MDN 文档。简洁、易读,并提供了有用的示例。非常高兴你们决定将其朝浏览器无关的方向发展。竞争对手应该学习一下,因为这是一个如何赢得开放网络社区思想份额的绝佳例子。

    2012 年 3 月 15 日 04:25

  5. Max

    超级酷。我已经将“https://mdn.org.cn/en-US/search?q=%s”的快捷方式映射到“mdn”关键字一段时间了。很高兴看到对文档的更多投入。

    2012 年 3 月 16 日 10:49

  6. Jeff

    MDN 文档很好,但我一直认为它们是 Mozilla 特定的。当您的页面出现在搜索结果中时,如果我正在寻找更广泛的内容,我通常会跳过它们。好吧,现在我已经阅读了这篇博客,我得到了启发,但其他人呢?

    认真考虑更改名称。我没有任何关于新名称的绝妙想法,但总的来说,类似“来自 Mozilla 开发者网络的通用 Web 参考”这样的名称可以融合浏览器无关的概念,同时保留 Mozilla 品牌。

    2012 年 3 月 20 日 05:32

  7. Jeff

    MDN 文档很好,但我一直认为它们是 Mozilla 特定的。当您的页面出现在搜索结果中时,如果我正在寻找更广泛的内容,我通常会跳过它们。好吧,现在我已经阅读了这篇博客,我得到了启发,但其他人呢?

    认真考虑更改网站的名称。我没有任何关于新名称的绝妙想法,但总的来说,类似“通用 Web 参考/来自 Mozilla 开发者网络”这样的名称可以融合浏览器无关的概念,同时保留 Mozilla 品牌。

    2012 年 3 月 20 日 05:35

  8. James Cox

    如果你们的搜索引擎能稍微好一点,并且你们向谷歌提交更好的网站地图,那就太好了——我不知道为什么 w3schools 在结果中总是胜过你们。

    2012 年 3 月 20 日 07:42

    1. Jean-Yves Perrier

      搜索引擎确实需要改进,这是正确的。
      在 w3schools 之前,仅仅一个网站地图是不够的。我们需要改进内容(例如改进标题),改进形式(速度、速度、速度!)并且最重要的是获得更多链接:他们多年来一直在收集链接,并且远远领先于我们。请注意,对于最近的 CSS 功能,我们的排名通常比他们好,因为我们或多或少在同一时间开始为这些页面建立人气。

      这就是为什么链接到我们会有很大帮助。

      2012 年 3 月 20 日 10:36

      1. Roland Frank

        提供有意义的标题——我愿意提供一个基于标题词和预测完成的查找界面。类似但已经过时的示例:http://taipu.de/ida.htm 可以通过最少的用户交互轻松访问维基页面。

        2012 年 3 月 21 日 16:12

  9. Hitesh Khandelwal

    我认为如果用户能够在维基页面上添加评论,MDN 会很棒。PHP 和 MySQL 文档之所以很棒,就是因为它们有评论功能。

    2012 年 3 月 20 日 10:28

    1. Jean-Yves Perrier

      我们正在考虑这样做。这有助于获得反馈,但最好的方法是将好的想法整合到文章中,但这会使评论变得多余(我们应该删除它们,这可能会让评论者不高兴)。

      这并不容易(除非像 php/mysql 一样,评论永远存在并且文章不会更新)

      2012 年 3 月 20 日 10:41

本文的评论已关闭。