MDN Web Docs 团队最近进行了一个项目，对“贡献文档”进行了大改版和重组。这些都是 MDN 上描述各种内容的页面 - 模板和页面结构、如何在 MDN 上执行任务、如何为 MDN 做贡献，以及在为这个庞大的开源项目做贡献时要遵循的社区准则。

贡献文档是作者浏览 MDN 项目的重要资源。社区以及合作伙伴和内部团队在任何情况下都经常参考它来交叉检查我们的策略或操作指南。因此，对这些页面进行整理，使其保持相关性和最新状态变得越来越重要。

清理

本文介绍了我们对“贡献文档”所做的更新。

重组

首先，我们将内容分组并重组为两个不同的类别 - 社区准则和写作准则。这就是项目提纲现在的样子

• 您现在可以在“社区准则”部分找到有关开源礼仪、讨论、流程、用户和团队以及如何与维护者联系的所有信息。
• 您可以在“写作准则”部分找到有关如何为 MDN 写作、我们写什么、我们认为什么是实验性内容等等的信息。

接下来，我们对信息进行了一些调整，使逻辑上类似的部分放在一起。我们还将散落在多个页面上的信息整理成更合乎逻辑的块。

例如，写作风格指南现在还包括有关“以 SEO 为导向写作”的信息，这在以前是一个单独的页面。

我们还重构了一些文档，比如写作风格指南。该文档现在分为“一般写作准则”、“写作风格”和“页面组件”部分。在以前的风格指南版本中，所有内容都分组在“基础知识”下。

更新和重写

总的来说，我们审查并删除了过时和重复的内容。清理工作还包括以下内容：

• 删除一些常见的程序性说明，例如设置 Git 和使用 Github，并将它们重定向到 Github 文档，而不是在 MDN 上重复步骤。
• 将一些特定于存储库的信息移到相应的存储库。例如，有关“将 Web 功能与浏览器版本号匹配”的内容在mdn/browser-compat-data存储库中更合适。
• 重写了一些页面，使它们与当前遵循的准则和流程保持一致。
• 记录了我们针对mdn/content与其他mdn上的存储库的问题和拉取请求的流程。这是一个持续的任务，因为我们调整和定义了更好的准则来与我们的合作伙伴和社区合作。

新外观

清理工作的结果是，新的“贡献者文档”结构如下所示：

社区准则

• 为 MDN 做贡献

• 开源礼仪

• 讨论

• 学习论坛

• 问题

• 拉取请求

• 内容存储库准则
• 用户和团队

写作准则

• 我们写什么

• 写作风格指南

• 操作指南

• 页面结构

• 署名和版权

• 实验性、已弃用和已过时内容

比较新旧版本

以下列表将让您了解先前版本中一些内容的新位置：

• “为 MDN 做贡献”
  • 新位置：社区准则 > 为 MDN Web Docs 做贡献

• “在 MDN 上入门”
  • 新位置：社区准则 > 为 MDN Web Docs 做贡献 > MDN Web Docs 入门

• “开源项目的礼仪规范”
  • 新位置：社区准则 > 为 MDN Web Docs 做贡献 > 开源礼仪

• “MDN 上的一切都在哪里”
  • 新位置：社区准则 > 为 MDN Web Docs 做贡献 > MDN Web Docs 存储库

• “本地化 MDN”
  • 新位置：社区准则 > 为 MDN Web Docs 做贡献 > 翻译内容

• “这属于 MDN Web Docs 吗”、“编辑政策”、“包含标准”、“选择流程”、“项目准则”
  • 新位置：写作准则 > 我们写什么

• “包含标准”、“选择流程”、“项目准则”
  • 新位置：写作准则 > 我们写什么 > MDN Web Docs 的包含标准

• “MDN 惯例和定义”
  • 定义的新位置：写作准则 > 实验性、已弃用和已过时内容
  • 惯例的新位置：写作准则 > 我们写什么

• “MDN 上的视频数据”
  • 新位置：写作准则 > 操作指南 > 如何添加图片和媒体

• “MDN 上的结构化数据”
  • 新位置：写作准则 > 操作指南 > 如何使用结构化数据

• “内容结构”
  • 新位置：写作准则 > 页面结构

总结

贡献文档是工作文档 - 它们会定期进行审查和编辑，以保持它们与编辑和社区政策的同步。对它们进行一次彻底的清理，可以使我们和我们的合作伙伴更轻松地进行维护。