如何通过为开源项目做贡献来提高你的技术写作技巧

发布时间 2023-06-13 07:17:48作者: 晓风晓浪

我知道,我知道,您可能听说过“为开源做贡献!” 在 Discord 群组和与技术相关的社交媒体帖子中无数次。但请相信我,这确实是获得技术作家经验的好方法。

首先,您可以从事经常公开展示的项目。这可能是向您的专业网络展示您的技能的好方法。

此外,与流行的看法相反,代码并不是您可以为开源项目做出贡献的唯一方式。您可以使用您的写作技巧来帮助维护人员改进他们的项目文档。

为开源做贡献会让你接触到新技术语言和软件,劳工统计局将其描述为技术作家的许多重要技能之一。

还是不相信?别担心——在本指南中,我将讨论如何找到需要技术作家的开源项目。我还将描述对这些项目的技术写作相关贡献可能是什么样子,并建议如何公开展示它们。

(更|多优质内|容:java567 点 c0m)

如何识别需要技术写作贡献的开源项目

许多开源项目在文档方面需要帮助。选择一个项目来做出基于文档的贡献将在很大程度上取决于您的兴趣、您拥有的写作技巧水平以及可用的机会。

在寻找需要贡献的开源项目时,我强烈建议向您的同事询问他们参与的项目。与朋友合作+开源?一个的价格是两个!:) 选择项目后,我的下一个提示是执行以下操作:

  1. 转到项目存储库上的问题选项卡。

指向问题选项卡的黄色箭头

\2. 单击标签部分

指向标签部分的橙色箭头

\3. 在文本框中输入“documentation”,瞧瞧!

文本框中出现“文档”

现在,如果您正在寻找更具体的东西,这里是我的开源项目列表,重点是文档:

好文档项目

如果您希望开始获得使用文档的经验,我强烈建议您加入这个小组。:) 他们有不同的工作组,专注于不同类型的写作,无论是创建其他开发人员可以在他们自己的开源项目中使用的文档模板,改进组织网站上的内容,还是对模板进行 QA(质量保证)社区成员创建。

代码学院

如果您精通某种特定的编程语言并希望与全世界分享这些知识,那么我强烈建议您为 Codecademy 的文档和文章存储库做出贡献。他们根据不同的需求提供模板,例如为特定章节提供新条目和更新/编辑现有条目。

天文

如果您是 Astro 的狂热用户,那么您可以在他们的文档库中分享使用该软件的技巧。他们的文档团队非常愿意与具有不同经验水平的成员合作。

现在选择一个项目只是一个步骤。让我们看看作为技术作家可以为开源项目做出贡献的一些不同方式。

作为技术作家为开源做出贡献的方法

恭喜!你已经选择了你的项目。现在,您只需要决定如何使用您的技术写作技能来做出贡献。

我知道这部分可能很困难,但不要担心——现在我们将讨论您可以做出的一些不同类型的贡献。

修改 README 文件中的拼写错误和其他语法错误

该文件对于开源项目的基础至关重要。这是他们描述项目目的和贡献步骤的地方,因此应该尽可能清楚地写下来。

如果您在通读 README 文件时发现缺少逗号或句子不明确,请向维护者提出问题并进行编辑(当然,如果他们同意的话)。

当我第一次加入他们的社区时,我就为 EddieHub 做出了贡献。这不仅是自我介绍的好方法,而且还教会了我如何为特定受众定制文档。现在这不是唯一的基于文本的贡献,让我们看看另一个!:)

创建内部文档样式指南

这需要创建一个指南,该指南定义了编写和格式化开源项目文档的标准。它有助于指导贡献者如何有效地为开源写作。

在本文档中,您将看到诸如标点符号应该和不应该如何书写、格式化代码块的具体方法以及贡献者在撰写有关产品的文章时应该使用的语气和语气等信息。

一个很好的例子就是Google 开发者文档样式中的缩写部分。

此外,在从Document Write 的 YouTube 频道观看了 Portia 的视频后,我决定为 EddieHub 的 Linkfree 项目制作一个文档风格指南。她谈到了开源贡献者,尤其是那些想以科技写作为职业的贡献者,如何从这些风格指南中受益。

通过创建本指南,我学到了以下内容:

  1. 以新的风格或语言编写:由于 Linkfree 的主要人口在英国,因此维护人员希望该指南以英式英语编写。我以前从未使用过这个版本的英语,所以学习单词的拼写、大写以及使用的标点符号很有趣。

  2. 使用新技术工具或框架:MDX (Markdown X)是贡献者用来维护 Linkfree 文档的技术语言。简单地说,是 Markdown 允许你放置JSX(让你将 HTML 代码放入 JavaScript 的语法)。我曾短暂地使用过 Markdown,因此在创建文档指南时实现这种语言要容易一些。

现在,风格指南只是您可以为开源项目做出的众多基于文档的贡献之一。让我们再看看另一个!:)

添加到产品教程

如果您擅长教学或发现自己正在阅读缺少关键信息的开源软件教程,请考虑将此作为您的贡献。

Audacity 网站上的教程部分就是一个很好的例子。它是一款免费的开源音频录制和编辑软件。

作为开源社区的新人,我注意到大多数初学者级别的内容从未真正提供有关贡献者如何在找工作或面试时实施他们的开源贡献经验的提示或建议。因此,我在 GitHub 上浏览 OpenSauced 的存储库,发现这类内容对他们的免费“开源简介”课程很有帮助。

我向公司的用户体验负责人Bekah介绍了我的想法,创建了一个拉取请求,然后 violà,它被合并了!

我强烈建议做出这种贡献,因为获得实践的一种好方法是为所有技能水平的全球受众简化技术内容。它还可以培养您注重细节的技能。

现在,在您开始之前,通过为开源项目做贡献获得技术写作经验时,还需要考虑一件事。

展示你的作品

当谈到展示您的作品的重要性时,Austin Kielon 说得最好:“展示您的作品”。

我的意思是,我们是大声呐喊的作家!通过文字显示内容是我们的 DNA,那么为什么不用我们自己的东西呢?

你可以通过你的博客、社交媒体帖子来写你的项目,或者录制一个关于它的播客片段。

如果您正在寻找更结构化的内容,我建议您使用OpenSauced的免费 Chrome 扩展程序。它是一种工具,可让您跟踪您当前贡献和计划贡献的 GitHub 开源存储库。

他们还有一个称为“亮点”的功能,您可以在其中选择某些贡献以发布到您的个人资料并在 LinkedIn 和 Twitter 上分享。要了解如何操作,请查看他们的教程。

这将是您在工作面试中参考的好东西,它可以为其他开源贡献者提供灵感。当我在 Twitter 上展示我为 Linkfree 创建的文档样式指南时,我的一位同事非常喜欢它,以至于她认为为她的项目提供一个文档样式指南会很好。所以根据她的要求,我创造了一个!:) 永远不要低估展示您作品的力量。

伙计们,这就是您通过为开源项目做出贡献来获得写作经验的指南。我知道这样做可能会令人生畏——尤其是一开始——但有了这些技巧和积极的态度,我知道你会成功的。

(更|多优质内|容:java567 点 c0m)