幕后花絮：SitePoint的同行评审程序

除非这是您阅读的第一篇JavaScript频道文章，否则您可能已经注意到在我们大多数文章（直到最近）中出现的一小段，即“这篇文章已由…同行评审”。 我想了解一下SitePoint的同行评审计划实际上是什么，为什么它很重要，以及如何参与其中。

什么是同行评审？

您可能对科学研究领域的“同行评审”一词很熟悉。 大多数著名的科学期刊都设有同行评审系统，以审查提交发表的研究论文。 请几位熟悉本文主题的科学家通读一遍，寻找任何潜在的错误或遗漏，并提出更正和改进的建议，以最终产生更高质量的出版物。

我们的同行评审系统以类似的方式工作。 将条款草案提交给我们后，我们会尝试从我们的志愿者池中寻找至少两个人，他们可以阅读该文章并向作者提供一些反馈。

草稿作为请求请求提交到我们在GitHub上的文章存储库，这使审阅者可以评论文章的特定部分，并与作者讨论建议的更改。 这通常导致评论中进行一些非常富有成效的对话，并促使一篇好文章变得真正出色。

尽管我们有一些非常出色的审稿人为我们提供帮助，但是很难获得足够多的评论来审阅我们收到的文章。 我们对某人的要求有一个限制（特别是因为他们在业余时间这样做），并且很难将一篇文章与具有相关主题经验的审阅者进行匹配。 因此，我们一直在寻找那些热衷于细节的热情志愿者，这可能是您吗？

成为审稿人的好处

如果您决定成为审稿人，那对您有什么帮助？ 主要的好处是，您在阅读每篇文章时所付出的努力将获得荣誉。 听起来可能不多，但是成千上万的读者会看到您的名字以及指向您的网站或社交媒体资料的链接。

成为审稿人也是您自己成为作者的重要踏脚石-您熟悉过程，其他审稿人，并增强了理解好文章的能力。

最后（不要小看），您正在帮助其他想要提高其JavaScript技能的人提供优质，免费的资源。 这是回馈事物并参与在SitePoint上闲逛的热情的作者，创作者和开发人员社区的好方法。

什么使一个好的评论？

那么，进行审核到底涉及什么呢？我们正在寻找什么样的反馈？ 首先，我们不希望您成为编辑-这是我们的工作！ 例如，当我们编辑文章时，会出现拼写和语法问题，因此，如果英语不是您的母语，请不要担心。 有用的评论重点在于文章的技术内容：包括代码和散文（文本）。

代码

查看代码时，有几项关键要注意的事情。 首先，代码是否存在任何基本的技术问题？ 变量或方法名称中的拼写错误，丢失的导入语句或逻辑错误？ 您不需要是用来捕获此类问题的框架或库的专家。

那么好的做法呢？ 代码是否遵循使用JavaScript或所用框架完成某些事情的惯用方式？ SitePoint致力于成为JavaScript文章和教程的高质量资源，因此，重要的是，我们发布的内容不要无意间鼓励不良的编码习惯。 值得注意的是，有些问题是作者的风格选择。 就是否使用分号进行辩论毫无用处！

教程通常会附带CodePen演示或GitHub存储库以及完整的代码。 演示是否可以在浏览器中正常工作？ 对于代码回购，作者是否提供了有关如何运行代码的足够说明？ 安装在您的计算机上运行正常吗？ 这些步骤可以帮助我们消除跨平台问题，例如，这可能会对使用其他操作系统的读者造成麻烦。

散文

如前所述，这里的想法不是要进行文学批评。 您能做的最有用的事情是戴上读者的帽子，问：“我能跟着做吗？”。 作者有时会沦为“知识诅咒”的猎物。 发生这种情况时，他们会假定读者具有与他们相同的背景知识，并且会错过对他们而言显而易见的重要细节。 指出可能需要进一步或更清晰解释的区域。

同样，本文是按照逻辑顺序引导您完成必要的步骤或概念，还是跳过步骤并在不相关的主题之间跳转？ 只是要求作者进行澄清的评论可以帮助他们理解读者的观点并改善文章的结构。

是否正确使用了技术术语？ 在诸如软件开发之类的任何技术领域，都有很多专业术语来描述不同的概念，技术和软件模式。 指出是否有任何以非标准方式使用的术语可能会引起读者困惑，这将很有帮助。 在硬币的反面，如果您认为不常见（但在技术上正确）的行话可能过于利基，最好用简单的英语解释来代替，不要害怕提及。

成为评论者

希望我能给您一些有关我们同行评审过程的见解，并可能激发您的兴趣。 如果您想帮助我们审核提交的内容，只需通过javascript@sitepoint.com与我们联系，并告诉我们您对编程的兴趣。 这可能包括您熟悉的框架和库，或者您有经验的实践（例如单元测试和TDD）。 这将帮助我们在可能的情况下为您提供符合您兴趣的文章。

如果您对同行评审有任何疑问或建议，以帮助我们做得更好，您可以通过上述地址给我们发送电子邮件或在下面发表评论！

翻译自: https://www.sitepoint.com/behind-the-scenes-sitepoints-peer-review-program/