正式定档!QCon 北京站改期为2024年4月11-13日,地点:北京·国测国际会议会展中心 >>> 了解详情
写点什么

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

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

    阅读完需:约 2 分钟

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

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


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


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


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


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


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


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


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


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


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


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


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

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

关注

评论

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

使用Rust的几点理由,加入我们,一起学习!

非凸科技

从旁观者到贡献者:经历 OpenYurt 的“开源之夏”,我们想让更多人体验社区的魅力

阿里巴巴云原生

小程序插件提升APP使用体验

Speedoooo

敏捷开发 APP开发 app性能 容器平台 小程序插件

技术解读:英特尔 x86 平台上,AI 能力是如何进行演进的?(附PPT)

OpenAnolis小助手

人工智能 X86 intel 自然语言模型

设计秒杀系统架构,这4个关键点要注意

华为云开发者联盟

秒杀系统 订单 秒杀系统架构 RabbitMQ延时队列 Rabbit MQ

【web安全】Spring boot heapdump获取敏感信息

H

Java 网络安全 WEB安全

ModStartCMS模块化建站系统 v3.4.0 富文本粘贴上传,自定义分页

ModStart开源

php laravel modstart

消息复杂计算的抽象和简化

阿里巴巴终端技术

数据处理 客户端 消息

网络协议之:socket协议详解之Datagram Socket

程序那些事

socket 网络协议 udp 程序那些事 3月月更

详解图像处理的算术运算与逻辑运算

华为云开发者联盟

OpenCV 计算机视觉 图像处理 图像算术 逻辑运算

如何选择最优路径完成云原生上云?听这场阿里云特别分享【云原生技术与最佳实践】

阿里巴巴云原生

免费机器资源、硬核导师、丰厚奖励|OpenI启智社区联合主办的飞桨黑客马拉松第二期开始啦~

OpenI启智社区

在线上传图片二维码识别解析

入门小站

工具

“==”和“===”,难道不是多一个的区别吗?

华为云开发者联盟

JavaScript typescript string 变量 操作符

网络安全 kali web安全【渗透测试】目录遍历漏洞

学神来啦

网络安全 渗透测试 WEB安全 kali kali Linux

业务驱动的全景监控体系在阿里的应用 | 阿里巴巴DevOps实践指南

阿里云云效

云计算 阿里云 DevOps 云原生 云端开发

Linux之scp命令

入门小站

Linux

C++后台开发学习路线

Linux服务器开发

后台开发 C/C++ 后端开发 Linux服务器开发 C++后台开发

NextRPC : RPC多段返回的创新和探索

阿里巴巴终端技术

RPC 客户端

Tech Talk 活动预告 | 送走 CentOS Linux 8,开发者们该如何保持 Linux 的采用途径?

亚马逊云科技 (Amazon Web Services)

开发者

国产虚拟化软件H3C CAS体验之环境搭建(虚拟机搭建)

WangNing

虚拟化 环境搭建 H3C CAS

什么是FAQ?如何编写FAQ文档?

小炮

5G和Wi-Fi市场与技术的一些思考系列之一

李伟-晨泳

Hoo虎符研究院|区块链简报20220314期

区块链前沿News

Hoo 虎符交易所

【CAD】系列Ⅰ

謓泽

3月月更

2021年券商APP盘点:用户规模大幅度增长,智能炒股成为行业标配

易观分析

券商

无缝融入 Kubernetes 生态 | 云原生网关支持 Ingress 资源

阿里巴巴云原生

云图说|DRS数据对比——带您随时观测数据一致性

华为云开发者联盟

数据一致性 DRS 数据复制 数据迁移

数字化时代,银行如何建设管理小程序平台促进线上金融业务发展?

FinClip

小程序 银行

网易数帆云原生日志平台架构实践

网易数帆

云原生 网易

基于微信小程序的运动场馆预约小程序开发笔记

CC同学

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