写点什么

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

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

    阅读完需:约 2 分钟

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

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


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


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


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


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


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


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


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


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


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


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


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

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

关注

评论

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

【愚公系列】2022年11月 微信小程序-app.json配置属性之Worker

愚公搬代码

11月月更

JVM Sandbox入门教程与原理浅谈

Zhendong

Java JVM

算法题学习---删除链表的倒数第n个节点

桑榆

算法题 11月月更

湖仓一体架构下的数据研发及管理

数造万象

泛型由入门到精通(3)

好程序员IT教育

Java 泛型

工信部电子五所李冬:在龙蜥社区的一站式自动化测试平台的探索和实践|2022云栖龙蜥实录

OpenAnolis小助手

开源 操作系统 自动化测试 龙蜥社区 2022云栖大会

OWASP API安全漏洞类型

阿泽🧸

11月月更 OWASP API

4K60帧!RayLink远程控制软件如何帮助设计师远程办公?

RayLink远程工具

远程控制软件 远程办公软件 远控软件 远程桌面连接 RayLink

EMI 滤波电路是由哪些元件组成的,一文看懂!

元器件秋姐

元器件采购 元器件电商 EMI滤波电路 滤波电路 元器件知识

精益创业者的用户体验设计

产品海豚湾

产品经理 产品设计 精益思想 用户体验 11月月更

构建高质量的持续交付体系

老张

软件工程 持续交付

浅谈MVC、MVP、MVVM框架模式

闫同学

mvc MVP MVVM 11月月更 框架模式

MySQL事务的隔离级别以及脏读、幻读和不可重复读

闫同学

MySQL 事务 11月月更

指标体系搭建中需要规避的问题

穿过生命散发芬芳

指标体系 11月月更

数据预处理和特征工程-特征选择-Embedded嵌入法

烧灯续昼2002

Python 机器学习 算法 sklearn 11月月更

九科信息受邀参加中国总会计师协会财务数智化转型研讨会

九科Ninetech

【Dubbo源码】SPI机制源码解析

石臻臻的杂货铺

dubbo 11月月更

初始Java诊断工具-Arthas

石臻臻的杂货铺

Java Arthas 11月月更

透视用户需求深挖服务潜力:2022中国商业查询行业洞察

易观分析

商业 查询

Thymeleaf入门教程

Studying_swz

前端 thymeleaf 11月月更

甩掉容量规划炸弹:用 AHPA 实现 Kubernetes 智能弹性伸缩

阿里巴巴云原生

阿里云 Kubernetes 云原生 AHPA

数字化转型有可能让所有人满意吗?

优秀

数字化转型

深入浅出学习透析Nginx服务器的基本原理和配置指南「初级实践篇 」

码界西柚

nginx 正向代理与反向代理 11月日更 nginx 开源版 开发指南

mysql的高可用方案以及优缺点

想要飞的猪

从0开始,让你的Spring Boot项目跑在Linux服务器

闫同学

spring Linux 服务器 11月月更

秒云加入OpenCloudOS操作系统开源社区,携手打造更智能、更可控、更可信的云原生环境

MIAOYUN

开源社区 opencloudOS

谈谈我对服务网格的理解

阿里巴巴云原生

阿里云 云原生 服务网格

基础逻辑门

芯动大师

Verilog 11月月更 Xilinx

AI音乐创作,让每一个人都成为音乐家

HarmonyOS SDK

音频 HMS Core

2022-11-14:rust语言,请使用过程宏给结构体AAA生成结构体AAABuilder和创建AAABuilder实例的方法。 宏使用如下: #[derive(Builder)] pub stru

福大大架构师每日一题

rust 福大大 过程宏

阿里云弹性计算总经理张献涛:智能化、高效能、新交互将重塑互联网

云布道师

弹性计算 云栖大会

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