写点什么

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

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

    阅读完需:约 2 分钟

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

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


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


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


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


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


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


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


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


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


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


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


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

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

关注

评论

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

Substrate 源码追新导读: 修复BEEFY的gossip引擎内存泄漏问题, 智能合约删除队列优化

彭亚伦

Substrate 波卡

Substrate 源码追新导读: 波卡系波卡权重计算全面更新, Governance 2.0 版本的优化和调整

彭亚伦

Substrate 波卡

Substrate 源码追新导读: 质押额度大幅度削减, RocksDB可以完全被Disable

彭亚伦

Substrate 波卡

波卡跨链通信源码探秘: 要素篇

彭亚伦

Substrate 波卡

dart:字符串replace相关的方法

坚果

flutter dart 6月月更

Substrate 源码追新导读: 5月中旬: Uniques NFT模块和Nomination Pool

彭亚伦

Substrate 波卡

大数据培训 | Flink专题面试

@零度

flink 大数据开发

互联网研发效能实践之去哪儿网(Qunar)核心领域DevOps落地实践

laofo

DevOps 研发效能 持续交付 研发管理工具 工程效率

​web前端培训 | JavaScript私有属性的实现方式

@零度

JavaScript 前端开发

图文并茂!手把手教你在VMware中的安装部署Linux-CentOS7.4

迷彩

Linux centos 开发 6月月更

Substrate 跨链技术源码级探索: XCVM的概览

彭亚伦

Substrate 跨链技术 波卡

数据安全合规之后,给风控团队带来了新的问题

博文视点Broadview

《网络是怎么样连接的》读书笔记 - 汇总篇

懒时小窝

网络

从前端开发角度理解如何与Substrate协作

彭亚伦

Substrate 波卡

Substrate 源码追新导读: Call调用索引化, 存储层事物化全面完成

彭亚伦

Substrate 波卡

实战|SpringBoot jpa调用MySQL存储过程

写程序的小王叔叔

SpringBoot 2 存储过程 Spring JPA 6月月更

我的远程办公总结|社区征文

DS小龙哥

远程办公 初夏征文

2022中国国潮发展新动向

易观分析

国潮消费

JS ES5也可以创建常量?🎃

德育处主任

JavaScript ES5 6月月更

拆分电商系统为微服务

Fan

「架构实战营」

等级测评是什么意思?工作流程包含哪些?

行云管家

网络安全 等保 等保测评 等级测评

Mybatis省略@Param注解原理

吴明

MyBatis标签 6月月更

几个跨端开发神器

Geek_99967b

小程序 小程序容器

实现多方数据安全共享,解决普惠金融信息不对称难题

易观分析

数据安全

Subtrate 源码追新导读-5月上旬: XCM 正式启用

彭亚伦

Substrate 波卡

Substrate 源码追新导读: Pallet Alliance 并入主线,

彭亚伦

Substrate 波卡

【等级测评师】等级测评师怎么报名?多少分及格?

行云管家

等保 等保测评师 等级测评师

百度直播iOS SDK平台化输出改造

百度Geek说

ios 直播

聊聊远程办公那些事儿 | 社区征文

joe

初夏征文

观测云与 TDengine 达成深度合作,优化企业上云体验

TDengine

tdengine 物联网 观测云

一对一直播app开发时,如何使用Nginx安全?

开源直播系统源码

软件开发 直播系统 一对一直播 一对一直播源码 直播源码

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