写点什么

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

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

    阅读完需:约 2 分钟

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

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


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


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


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


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


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


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


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


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


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


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


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

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

关注

评论

发布
暂无评论
发现更多内容

看懂这篇文章就够了!什么是Redis缓存雪崩、缓存穿透和缓存击穿-五分钟统统搞定

Java 程序员 后端

源码分析ElasticJob选主实现原理

Java 程序员 后端

漫谈一条SQL语句的一生

Java 程序员 后端

牛批!Java集合框架面试题精华集(2020最新版),附PDF版

Java 程序员 后端

牛!阿里巴巴首推的《Java进阶必备宝典》,从理论到实战

Java 程序员 后端

独角兽余额宝(Java现场面试48题):性能调优+索引+Mysql+缓存

Java 程序员 后端

白嫖!白嫖!【尚学堂】高淇Java300集全套学习资料

Java 程序员 后端

盘点阿里巴巴 34 个牛逼 GitHub 项目

Java 程序员 后端

牛皮!华为工程师总结的Java生态知识体系面试必看笔记,太秀了

Java 程序员 后端

用好这几个技巧,解决Maven-Jar包冲突易如反掌

Java 程序员 后端

看完这套Java笔记,才明白笔者同时斩获7份大厂offer是有原因的!

Java 程序员 后端

爱了,在GitHub超火的Java程序性能优化实战笔记,实在太香!

Java 程序员 后端

看看AQS阻塞队列和条件队列

Java 程序员 后端

直呼内行!阿里大佬离职带出内网专属“高并发系统设计”学习笔记

Java 程序员 后端

疫情宅家4个月苦修,“不负年华“终斩阿里Java岗4面,分享下心路历程

Java 程序员 后端

牛逼,这2招,彻底让你和 null say 拜拜

Java 程序员 后端

玩转互联网公司面试!快手、爱奇艺、小红书等14家互联网企业面经分享!

Java 程序员 后端

生产环境JVM内存溢出案例分析

Java 程序员 后端

男默女泪!全网疯传的华为内部网络协议神仙笔记究竟有何魅力?

Java 程序员 后端

盘点郭德纲那些“催人奋进”的经典语录 -- 致被我们浪费的时光

Java 程序员 后端

源码分析Dubbo服务消费端启动流程

Java 程序员 后端

直播阿里远程面(钉钉部门),三面坐上“直通车

Java 程序员 后端

看了这篇文章后,面试官再也不敢问你非结构化存储的原理了

Java 程序员 后端

看透了 Redis 源码之后,我总结出来的几点心得

Java 程序员 后端

源码分析Dubbo 泛化调用与泛化实现原理

Java 程序员 后端

用 Java 爬美女图片,这个厉害了!

Java 程序员 后端

用时17天完成4面阿里,已斩获offer,总结下个人面经心得体会

Java 程序员 后端

电商中的SPU与SKU

Java 程序员 后端

盘点那些进行“网络编程”必须要知道的基础知识!

Java 程序员 后端

看一遍就理解:动态规划详解

Java 程序员 后端

看完这篇还不懂HashMap的扩容机制,那我要哭了~

Java 程序员 后端

谷歌推出“文档季”计划,改进开源文档质量_开源_Andrew Morgan_InfoQ精选文章