MDN 网页文档:编辑策略和社区参与

在过去几个月里,我们为 MDN Web Docs 的发展取得了很大进展,我们想分享一下我们在短期和中期内的发展方向,首先是我们的编辑策略,以及我们对社区参与的重新努力。

新的编辑策略

我们更新后的编辑策略有两个主要部分:内容支柱的创建和编辑日历。

MDN 编写团队一直负责维护 MDN 网页平台参考文档的最新状态,包括关键领域,例如 HTMLCSSJavaScriptWeb API。我们将这些关键领域划分为“内容支柱”,我们将依次处理这些内容,以确保每个月都记录下重要的新的网页平台更新。

注意: 这也意味着我们可以重新开始发布我们的 Firefox 开发者发布说明,这样您就可以随时了解我们在每个新版本中支持的内容,以及 Mozilla Hacks 文章,以便您进一步了解我们在 Firefox 工程方面所做的事情。

我们还将与 产品咨询委员会 上的合作伙伴(以及提供意见的社区的其他成员)一起创建和维护编辑日历,这将帮助我们优先考虑未来对 MDN 文档的一般改进。例如,我们希望为重要的与网页平台相关的主题(如可访问性、性能和安全性)创建更完整文档。

MDN 将与领域专家合作,帮助我们更新这些文档,并从您和我们社区的其他成员那里寻求帮助——这就是我们在这篇文章的剩余部分中想要讨论的内容。

社区参与呼吁

MDN 上有许多日常任务需要完成,包括审核内容、回答 Discourse 论坛 上的问题,以及帮助修复用户提交的内容错误。我们希望您能帮助我们完成这些任务。

为此,我们重写了我们的 贡献 MDN 页面,以便更轻松地找到有关如何执行特定原子任务的说明,这些任务将有助于减少 MDN 积压的任务。我们目前需要帮助的主要任务是

  • 修复 MDN 内容错误——我们的 sprints 仓库 是人们提交问题以报告在 MDN 文档中发现的问题的地方。我们收到了很多这样的问题,任何您能提供的帮助,例如修复问题,都将受到高度赞赏。
  • 帮助初学者在 MDN 上学习——我们的 学习网页开发 页面每月浏览量超过一百万,并且有 活跃的论坛,人们可以在那里寻求一般性的帮助,或请求他们的评估被标记。我们希望在回答帖子和发展我们的学习社区方面得到一些帮助。

我们希望这些变化将有助于使 MDN 社区重新活跃起来,使其成为一个更加友好、包容的地方,任何人都可以放心地来这里获得文档帮助,或学习新的技术或工具。

如果您想与我们交谈、提出问题和了解更多信息,请加入 MDN Web Docs 聊天室 的讨论,该聊天室位于 Matrix 上。我们期待与您交谈。

其他有趣的进展

MDN 团队目前正在努力进行一些其他有趣的项目,并将通过未来的博客文章提供更深入的介绍。在这里我们简单介绍一下。

平台演进——MDN 内容迁移到 GitHub

一段时间以来,MDN 开发团队一直在计划一项彻底的平台变更,我们现在已准备好开始分享其细节。简而言之,我们正在更新平台,从使用 MySQL 数据库将内容存储在 Wiki 中的方式迁移到使用 Git 仓库托管内容的方式(代号:Project Yari)。

这对最终用户来说不会有任何影响,但 MDN 开发团队和我们的内容贡献者将看到许多好处,包括更好的贡献工作流程(通过 Github)、我们与社区合作的更好方法以及简化、易于维护的平台架构。我们将在下一篇博客文章中详细介绍这一点!

Web DNA 2020

2019 年的 网页开发者需求评估(Web DNA)是一项开创性的研究,它已经帮助塑造了网页平台的未来,来自超过 28,000 名网页开发者的意见帮助确定了网页开发中的主要痛点。

Web DNA 将在 2020 年再次进行,与 Google、Microsoft 和其他几个利益相关者合作,他们将为今年的问题形式提供意见。我们在 10 月 12 日启动了 调查,今年的报告将在年底前发布。

关于 Chris Mills

Chris Mills 是 Mozilla 的高级技术作家,他编写有关开放网页应用程序、HTML/CSS/JavaScript、A11y、WebAssembly 等方面的文档和演示。他喜欢用网页技术捣鼓,并且偶尔会在会议和大学进行技术演讲。他曾为 Opera 和 W3C 工作,喜欢玩重金属鼓和喝好啤酒。他住在英国曼彻斯特附近,与他的妻子和三个可爱的子女生活在一起。

更多 Chris Mills 的文章……


4 条评论

  1. Mark

    我很高兴平台改进工作还在继续。问题:有没有可能在动态示例下方重新添加 CodePen/JSFiddle 按钮?我认为这些按钮非常有用。

    我还希望看到每个页面顶部的 CSS 示例得到升级,这样我们就可以看到所有代码——有时一两行 CSS 不足以完全理解正在发生的事情。

    2020 年 10 月 22 日 下午 11:37

    1. Chris Mills

      感谢您的反馈,Mark。我们将在新平台上从一小部分功能开始,然后逐步构建它。您提到的这两点想法绝对值得考虑。

      2020 年 10 月 23 日 上午 01:58

  2. Clark

    令人兴奋的事情!
    巧合的是,我昨天正在阅读有关 MDX(Markdown-X)的信息,只是想轻轻地提醒您说:“嘿,也许这很适合您迁移到 Github 后使用的文档”。

    如果工作流程很好,例如使用 Markdown 和 Github,我很乐意做出贡献。

    保持强大!

    2020 年 10 月 22 日 下午 11:24

  3. Chris Mills

    嗨,Clark!你是说 https://pypi.ac.cn/project/django-markdownx/ 吗?看起来真的很有趣,尽管目前的计划不包括使用 Django 进行内容编辑。但永远不要说永远不可能,至少现在还不是。

    最初内容将是 GitHub 中的原始 HTML,但我们打算在未来将其迁移到某种 Markdown 风格(可能是我们自己的自定义 MDN Markdown)。

    2020 年 10 月 23 日 上午 02:00

本文的评论已关闭。