开源可见性技巧 - 无需令人厌恶的营销

成百上千的工程师将他们的项目放在 GitHub 上，然而，出于某种原因，许多潜在用户根本找不到这些项目。开源作者通常拥有顶级的编码技能，但用户拓展可能是一个挑战。也许他们只是不想与开源社区中声名狼藉的任何“营销”手段混在一起。或者，他们只是性格内向。

我在一家名为 Evil Martians 的公司工作，该公司拥有 100 多个 OSS 项目，我的工作是帮助这些项目的创建者让用户更容易访问这些项目。

忘记追逐用户或一头扎进营销 - 内向的人欢呼吧！您可以采取五个实际步骤来推进您的项目，所有这些都不需要我的特定技能。

您需要用户；用户需要您

无论您构建开源的原因是什么（是为了提高您的技能、解决您无法摆脱的问题、为伟大而有前途的事业做出贡献，还是为了 GitHub 星星），您都需要用户。 

没有用户，我们就无法改进我们的项目，因为我们生活在我们自己的问题空间中，这个空间很可能非常有限。我们正在构建的产品可能适用于许多情况。

然而，在实践中，开发人员不会盲目滚动浏览 GitHub 来寻找有用的项目。相反，他们会搜索、在社交媒体上关注有趣的工程人员、订阅新闻通讯或参加会议。

因此，考虑到这一点，让我们概述一些步骤来帮助用户找到您，并将您纳入流通。

第一步：整理您的 README

许多项目的描述为空，文本单薄。然而，描述是最关键的——它使读者能够理解工具的作用，并激励他们使用它。 

这是最佳 README 结构

1. 清晰的描述
2. 它的用途
3. 它的重要性
4. 它与其他解决方案的区别

您可以通过参考我们自己的开源产品：Nano ID 和 Autoprefixer 来为塑造 README 中的内容寻找一些灵感。 

README 非常重要，但它也是最难创建的内容——有时，可能需要数周时间才能正确而彻底地完成。 

我建议使用这种技巧：告诉您的朋友（或者，对于内向的人，可以使用 AI 工具，或者您自己）关于您的项目想法——您甚至可以录制并转录您的演讲。在这个过程中，尝试尽可能清晰简洁地解释您的想法。

如果在那之后，您仍然无法组织您的内容，那么很可能是因为您正在尝试创建一种用“推销”词语精美包装的营销文本。这种心态让您考虑形式化，而且也毫无用处，因为人们再次不会搜索精美的营销短语。 

相反，使用非正式的语言。您甚至可以变得情绪化或使用愤怒的语气，使用不适合上流社会的措辞，或者，在最坏的情况下，使用一些健康的粗俗语言。无论您做什么，都要尝试超越“美丽”文本的限制，这种文本会推销您的产品，而是像那些将搜索您必须解决的相同解决方案的人一样思考。

忘记花哨的营销语言。人们搜索的是解决方案，而不是精美包装的“推销”词语。

在您将所有内容都表达出来之后，您可以摆脱最令人不快的术语并重写整个文本，使其更专业。编写几个不同的迭代版本，并与您的用户一起测试它们。

为了锦上添花，添加一个提示和方法来获取反馈，例如“如果您发现本文档含糊不清或不够清晰，请提交 issue 或 PR。让我们一起把它做得更好！”

第二步：使其具有吸引力

接下来，让我们把目光投向使我们的 README 文件更引人注目。

许多研究人员报告说，人们实际上并没有在网上“阅读”东西（相反，他们扫描文本，而不是逐字逐句地阅读。）例如，尼尔森·诺曼集团的研究（其中包括通过眼动追踪收集的数据）表明，读者最关注开头部分和任何特色细节。

因此，让您的读者可以轻松扫描并找到对他们最重要的信息。具有引人注目的细节（如列表和粗体类型）的 README 可以突出关键点，而图像的使用 （屏幕截图、徽标、图表——自从 GitHub 最近添加了 Mermaid 支持以来，这非常容易）也是一个好主意。要创建漂亮的代码片段，您可以使用漂亮的开源等宽字体，如 Martian Mono、FiraCode、Iosevka 或 Monaspace。

第三步：消除任何危险信号

当开发人员搜索问题的解决方案时，他们不会输入诸如：“我想找到一种前所未有的创新部署自动化解决方案。”之类的东西。他们使用具体的术语，而这些具体的术语应该存在于您所有形式的内容中。

特别是，停止使用流行语——因为这些是潜在用户的危险信号。

我敢打赌，您有自己最讨厌的 IT 流行语列表，例如“快如闪电”、“摇滚明星”或“生态系统”。（据我记录，我的是“创新”。）但是，如果您在 GitHub 上搜索这样的词，您会感到不知所措。例如，您将看到包含“创新”的开源项目描述数量为 19.7K，而“快如闪电”的数量超过 5.1K。

如果您的产品是“最快的”、“最小的”，或者只是比其他产品更好——请提供证据，例如基准和统计数据。

我们在为我们的开源图像优化项目 imgproxy 使用“快如闪电”时犯了这个错误。值得庆幸的是，我们很快意识到了我们的错误，并将其从我们的 README 中删除，而是提供了基准测试结果。

第四步：保持一致

在 README 完成之后，您已准备好为社区做出巨大贡献。但为了保持可见性和可搜索性，请记住这是一场马拉松，而不是短跑。因此，这意味着我们应该准备好定期生成我们的内容。

这击中了两个目标。首先，它表明您的项目没有死，问题将得到及时处理，并且用户将获得新功能（被遗弃的 OSS 项目是一个巨大的问题。）其次，新鲜内容向搜索引擎发出活动信号，可能会提高您产品的排名。

关于最后一点的另一点：当人们在线搜索问题的解决方案时，他们会使用不同的关键词组合。这就是为什么我们需要不断使用不同的措辞。

因此，重复使用和重新利用您的内容。创建一个好的 README 并将其变成一篇博客文章。编写一个关于如何使用您的项目的指南（它们非常有效！）并将其转换为社交帖子、Reddit 帖子，以及再次，一篇博客文章。宣布发布和新功能，感谢贡献者，定义用例，分享重大修复，并发布基准。

例如，对于我们的一个 OSS 项目 AnyCable，我们不断重复使用我们的内容并将其转换为屏幕广播剧集、新闻通讯或 Twitter 和博客文章，以持续与我们的用户互动。

第五步：寻找更多内容创意

找不到内容创意？写下困扰您太久以至于您决定创建自己的工具来解决它的问题。或者编写一个教程来展示如何使用您的功能或特定技术堆栈的用例。想想您在开发过程中遇到的问题。或者，考虑您测试过但不适合的解决方案。

并尝试甚至从负面反馈中汲取灵感：分享关于您的问题以及您如何解决（或未能解决！）它们的故事。

总的来说，我们需要与用户联系的地方，我们激活的内容和渠道越多，效果就越大。并务必倾听您的用户和贡献者——他们将帮助您找到下一个内容的想法。

请记住：开发领域的推广实际上是关于同行支持，这对所有人来说都是双赢的。人们使用我们的开源，创建 issue 并发送 pull request。通过集体讨论用例、解决非平凡问题和查看其他人的代码，我们为更伟大的事业做出贡献。

这种方法避开了“令人厌恶的营销”，即那些虚假和咄咄逼人的策略，会让人们反感。我们都厌倦了没有真正价值的过度炒作的功能、没有数据支持的夸大其词的声明，或淹没真正价值的过度促销内容。良好的描述和文档、易于查找以及定期内容是高质量 OSS 项目的标志。

本文是我们关于实用开源 (POSI) 计划系列文章的一部分。POSI 旨在促进关于与开源进行业务往来的讨论。2024 年版包括 OpenSource.net 上的博客文章和 10 月在 All Things Open 上的小组讨论。有关更多详细信息以及如何投稿，请访问 POSI 2024 页面。