自从Yoast SEO插件3.0版本发布以来，JavaScript一直是其中的重要组成部分。我们依靠它来实现高端功能，比如实时内容分析。使用JavaScript的决定意味着开发团队必须在技术和工具方面做出许多选择。所以，我们必须牢牢掌握WordPress中JavaScript的用法。
在做Yoast SEO 3.0的时候，我们发现很少有WordPress贡献者拥有丰富的JavaScript知识。在2016年欧洲WordCamp的贡献者日，我们看到了一个帮助WordPress推进互联网未来的机会。通过在WordPress中记录JavaScript，我们可以让每个人更容易地构建和增强代码。
我们相信JavaScript会继续存在下去。它是一种伟大的语言，有助于丰富人们在web上享受的用户体验。但是为了更好地实现JavaScript和理解WordPress核心，我们必须弄清楚到底发生了什么!
这意味着记录下所有做决定的地方，神奇的事情发生的地方，或者处理复杂情况的地方。此文档是维护所有功能的必要条件。防止误解导致错误或其他问题也是至关重要的。这些见解促使我们致力于记录WordPress中使用的所有现有JavaScript文件。
我们如何开始
我们所做的第一件事就是在开发日程表中预留一个位置。每周四我们有两个小时的时间处理文档。这意味着在这段时间内，办公室里的所有开发人员都要在WordPress core activity上工作。目前主要关注的是JavaScript文档，因此每个人都将把时间投入到这个特定的任务中。在未来，我们可能会致力于核心的其他部分。
为了让事情顺利进行，我们首先简要介绍了我们的意图和目标。这次会议之后，我们制定了一个切实可行的办法。该方法由指导方针和工具组成，以确保统一的结果。每一个结果都必须遵循所有的标准。我们使用这些来确保每个人都以同样的方式工作。
工具:JSDoc
因为我们正在编写JavaScript文档，所以使用JSDoc来生成文档状态的视图是合乎逻辑的。WordPress标准规定了文档中应该使用哪些特定的标签。它主要用于验证在预期位置上所有东西都是可见的。
WordPress:编码标准
WordPress对代码的格式有一个精确的定义。这确保了整个代码库具有相同的外观和感觉。它帮助开发人员在整个平台上提供统一的体验。你们都知道这些定义是编码标准。WordPress为PHP和JavaScript实现了单独的标准。
还有一个关于如何格式化JavaScript文档的精确定义。可以使用工具来生成文档。如果您这样做，您可以使用特殊的关键字来提供关于文档化的代码的额外信息。
优先级文件
首先，我们创建了WordPress安装中提供的所有JavaScript文件的列表。从这个列表中，我们确定了哪些文件是最复杂的，哪些文件位于最关键的位置。通过这种方式，我们制定了一个优先级列表。
每周奉献与未来
每个星期，我们所有的开发人员都有两个小时的时间来结对并为一个特定的文件编写文档。所有的补丁都是在提交给core之前在Yoast内部审核的代码，我们试图让审核和合并变得尽可能简单。目前，我们总共向WordPress核心库提交了5个补丁。其中三个已经在即将发布的4.7版本中合并了。
对于提交的补丁，我们收到了非常热烈的反馈。除此之外，我们玩得很开心(有一些挫折)，搞清楚到底发生了什么。你想跟随我们更好地了解WordPress核心吗?如果是这样，找到没有文档的代码，确定它做什么，编写文档并创建一个补丁。这是最令人满意的事情之一，它让核心文档维护人员非常高兴!
未完待续……
我们将继续记录这些文件，直到全部完成。在那之后，我们将评估我们将如何和在哪里让我们的团队工作。我们可以改进现有的功能、架构和效率，但也可以开发新的特性并为未来引导核心。
你想帮忙吗?或者你需要在WordPress核心中为你自己的JavaScript编写一个补丁吗?然后你应该学习WordPress JavaScript文档标准。