dot Redis 8 已发布——并且是开源的

了解更多

转向敏捷、开源文档

如今,“开源”在技术领域具有很多含义。 在该术语创造二十年后,开源项目利用自愿贡献者的力量来生产和支持软件,这些软件正在迅速增长,影响着每个行业、每个地点。

从本质上讲,开源仅仅意味着产品随附用于生成它的代码。 访问此源代码的能力会产生修改和重新打包的潜力,这些潜力受各种开源许可证的约束。 它还可以让人们将修改贡献回核心项目,从而使每个人都从这些修改中受益。

作为一家建立在提供卓越服务和促进共同利益原则之上的软件公司,我们在 Redis 决定将这种开源敏捷性引入到一个鲜为人知但影响深远的领域——产品文档。

我们认为,将开源与文档结合起来是一个很好的组合,可以为我们的社区提供

  • 始终保持最新的信息
  • 一个来自他人的协作贡献平台
  • 来自敬业社区的高度准确的细节

要了解如何参与贡献,请查看我们的贡献指南

那么,我们为什么要选择开源方式编写文档呢? 要理解这一点,让我们看一下过去几年技术文档的演变。

上次革命——弥合交付差距

过去,文档是软件开发截止日期中的一个绊脚石,因为围绕软件使用的所有支持性解释必须与软件本身同时交付。 更糟糕的是,它最初是印刷材料(想想用户指南!),不仅创建速度慢,而且更新起来更加困难。

幸运的是,随着技术的进步,我们能够以数字格式更新用户文档,从而节省了印刷和运输的“沉重”成本。 作者可以像工程师提供软件补丁一样轻松地向客户提供更正、重写和更新。

这场革命弥合了交付差距,使公司能够在产品的生命周期内改进文档。 但是,仍然存在严重的瓶颈,阻碍了客户获得尽可能最好的信息。

另一个痛点——我是一个瓶颈

那么,传统上是什么阻碍了获得最准确的产品信息? 作者!

技术作者是唯一的内容贡献者,他们站在技术专家和客户之间,提供客户可以可靠且高效地使用的技术信息。 诚然,没有技术作者的产品可能难以使用,但是作者充分理解信息并进行编写所花费的时间和精力是另一个瓶颈。

agile Blog image 2

由于技术作者通常是唯一有权访问已发布文档的源文件的人,因此任何更正、重写或更新贡献都必须由他们输入并生成为最终格式。

下一次革命——开源文档

开源赋予每个人一定级别的产品源文件访问权限。 对于 Redis 文档,这意味着将文档的源文件放在公共可访问的存储库中。 任何人都可以查看这些源文件并编辑文件的副本以提出贡献建议,从而将作者从内容所有者更改为内容编辑者和管理者。 您甚至可以直接从我们文档中每个页面上的“在 GitHub 上编辑”链接到达那里。

Agile Blog Image 1

方法上的这种简单改变将文档准确性的所有权开放给 Redis 内部的技术专家,以及每天都在体验产品行为的客户和合作伙伴。 将其添加到 docs.redis.com 上立即交付的已批准贡献,我们已大大提高了为客户提供最新和准确文档的能力。

我们不会停下来

当然,这仅仅是我们为产品文档带来的改进的开始,但我们认为此举将成为未来诸多好处的基础。

因此,如果您想帮助每个人充分利用世界上最快的数据库,请不要犹豫——贡献!