写点什么

谷歌推出“文档季”计划,改进开源文档质量

  • 2019-03-25
  • 本文字数:711 字

    阅读完需:约 2 分钟

谷歌推出“文档季”计划,改进开源文档质量

谷歌推出了“文档季”计划,旨在改进开源项目的文档质量。它将通过在开源贡献者和技术作者之间建立指导关系来实现该目的,从而帮助各种开源技术创建更强大、更全面的文档。


“文档季”的动机来自开源调查,该调查表明,很多开源项目缺乏良好的文档。谷歌认为,这是因为文档的创建相当困难,所以启动了这个计划来改进开源项目的文档质量。


该计划的潜在参与人员将分为两大类,导师或技术作者,这两者将合作产出文档。谷歌解释道:


在“文档季”期间,技术作者将花上几个月的时间与开源社区紧密合作。每个作者与其所选择的开源项目合作。作者们把他们的专业知识用于项目文档,同时学习有关开源和新技术的知识。


技术作者首先会进入探索阶段,找到他们可能感兴趣的项目。在此之后,他们可以和相应的组织讨论他们的想法。接着进入申请阶段,如果申请成功,技术作者就可以开始处理文档,并在此期间与导师紧密合作。


就像技术作者一样,导师也将经过申请阶段。在该阶段,他们也将被要求找到将技术作者紧密合作的导师。如果申请被接受,他们将负责从技术作者申请人中选择技术写作项目。


在具体的工作方面,项目可能涉及创建全新的文档、改进已有的文档或更好地记录开源贡献过程。


让我们一起提高公众对开源文档、技术写作以及我们如何合作造福全球开源社区的意识。


符合条件的导师必须积极运作开源项目,而技术作者要能够展示以前的技术写作经验。技术作者还将获得工作补贴。


谷歌已经为该计划制定了时间表,导师的申请提交从 4 月份开始,技术作者的申请提交从 5 月份开始。更多相关信息请参考网站,内容包括如何参与该项目的步骤以及常见问答。


查看英文原文:Google Launches “Season of Docs” Program to Improve Open Source Documentation


2019-03-25 08:002793
用户头像

发布了 199 篇内容, 共 81.8 次阅读, 收获喜欢 293 次。

关注

评论

发布
暂无评论
发现更多内容
谷歌推出“文档季”计划,改进开源文档质量_开源_Andrew Morgan_InfoQ精选文章