文档是任何编程平台的重要组成部分,我们付出了很多精力在文档中添加高质量内容。如果您想帮助我们创建和完善文档,此页面将说明您需要做些什么。一旦我们采纳了您的文章并发布在本章节中,我们将向您的 PayPal 帐户支付 50 美元的稿费,或者向您的游戏帐户充值 5 个订阅令牌(大约相当于90美元),具体取决于您的选择。
我们需要的文章
我们欢迎以下类型的文章:
- 在官方文档中没有涉及到的,有关于复杂游戏机制和玩法的通俗介绍。
- 如何完成一些基础或者简单目标的分步教学。
- Screeps 中一些常见任务功能的解决思路和途径。
- 如何设置外部环境、或者使用第三方工具、库或者编译器。
要考虑的事项
- 选择官方文档和其他用户提供的文章中最少涉及的主题。
- 如果您想修改现有文章,则应该提交有实质性的内容,并且新增的内容量不要低于要修改的原始内容。如果您提交的内容不足,或者与 Screeps 及其他来源的文章过于相似,则可能会被拒绝。
- 请勿撰写包含大量现成代码的文章或者直接提供玩家可能更喜欢自己发现的复杂解决方案。相反,请描述他们可能面临的具体问题和挑战,并提供寻找解决方案的方向。
- 在审核阶段邀请其他用户讨论您的 Pull Resquest,从而提高您文章的质量。
- 从您自己的网站或社交媒体帖子链接到您发表的文章。实际上,由于 SEO(链接权重)带来的影响,您自己网站的页面排名可能会提高不少。
内容准则
文章应友好的提供信息。尽可能使用主动语态,如使用”您“或”我们“而不是”我“来进行叙述。请避免无用信息,并且尽量简要直接的进行说明。注意,提交的内容必须以英文撰写,并包含高质量的内容。我们希望可以在文章中发现下列要点:
- 准确性:介绍应简洁明了,技术上正确且经过全面测试。包括每个步骤的简要说明,以解释每个操作的目的。 文章可以使用与 Screeps,JavaScript 和相关主题有关联的技术术语,但是如果是只有很少人知道的高级概念术语 - 请使用尽量通俗的语句解释它:用一两句稍微描述一下,或者链接到文档页面。
- 完整性:如果您编写的是指南或者操作教学,请向读者提供一个完整有效的配置,并且介绍在这之前应该做什么和之后应该做什么。
- 原创性:内容应该是为 Screeps 编写的原创材料。我们不接受其他来源(包括个人博客)的重复内容。
如果您想先看看您的内容是否符合我们的要求,然后再花时间写一篇文章的话,您可以先写一篇简单的样稿然后发送到 contact@screeps.com。
提交流程
在 GitHub 上以 pull request 的形式将您的文章提交到 screeps/docs。
所有的文章将在 GitHub 上保留两周的时间,以供社区评论或提交自己的 PR。在此过程中,您可能会收到我们的提问或评论,请据此对请求进行修改,或者对更改进行重新提交。
当接受该文章后,我们会将最终版本作为 pull request 提交到您的 GitHub 分支。您将有 36 个小时的时间来答复和审核我们发布的最终版本。如果您的回答是肯定的,我们将发表该文章,而您将收到付款。无回应将被视为可以发表。
法务信息(中)
译者注:本小节的翻译仅限了解用途,具体信息请参阅下方的法务信息(英)。
版权所有权。作者同意为向 Screeps 文档库贡献文章进行工作。并且作者在开发的各个阶段创建的每种形式的材料均应是且仍然是 Screeps 的专有财产。根据 Screeps 的绝对唯一决定权,Screeps 可以对作品进行任何更改。
名誉。本协议中的任何内容不得视为要求 Screeps 通过结合 Screeps 文档或其他方式来使用本作品或本作品的一部分。作品的名誉信息应为“由作者贡献”。
付款。在向 Screeps 文档库中提交稿件后,作者将获得 50 美元的在线付款或 Screeps 账户中的 5 个订阅令牌。
法务信息(英)
COPYRIGHT OWNERSHIP. Writer agrees that the Work is being created by the writer for the Screeps Documentation Contributed Articles repository and that each form of Work is being created by the writer, at all stages of development, shall be and remain the sole and exclusive property of Screeps. At Screeps’s sole, absolute and unfettered discretion, Screeps may make any alterations to the Work.
CREDIT. Nothing contained in this Agreement shall be deeded to require Screeps to use the Work, or any part thereof, in connection with Screeps Documentation or otherwise. Credit for the Work shall read, “Contributed by writer’s name.”
PAYMENT. Upon publication of a submission to the Screeps Documentation Repository, the writer will be paid either the sum of USD $50.00 either as an electronic payment or a credit of 5 Subscription Tokens to their Screeps account.