CockroachDB文档中的可访问性改进和交互式SQL Shell现已出现

70 阅读5分钟

CockroachDB文档网站是我们为CockroachDBCockroachCloud这两个产品提供的产品文档。它包括参考文档、概念文档、开发者指南、教程等等。

蟑螂实验室一直把文档放在首位,在公司成立之初就对其进行了投资。我们相信清晰、简明和有帮助的文档对于使我们的用户在测试、部署和与我们的产品互动时能够自给自足非常重要。它们是内部用户,如支持和销售,也参考的重要工具。每个文件都要经过彻底的研究、起草和审查过程--虽然我们的文件团队拥有这个过程,但这是一个合作的努力。很多时候,一个由工程师、产品经理、设计师、客户成功人士--甚至是我们社区的成员--组成的跨职能小组将做出贡献。

但是,无论我们的内容有多好,如果你不能找到你要找的东西,那就意义不大。我们决定重新设计我们的网站,以改善其功能,使我们的网站更容易让用户发现相关内容,并在文档中进行微调和增加功能。

当你探索新的网站时,你会看到许多事情已经改变。

我们在导航方面采取了一个新的方向。要浏览文档,现在有一个左边的面板,显示以下内容。

我们相信这将使用户在浏览我们的文档时更容易找到他们要找的内容。

我们还增加了完全重新设计的产品区域登陆页,作为新用户了解每个产品的入口,并让老用户了解新的发布。

我们为CockroachCloud提供了一个登陆页面。

CockroachCloud Docs

以及CockroachDB

CockroachDB Docs

对CockroachDB文档的数字可访问性的改进

那些关注细节的人可能也会注意到,一些小的可用性错误已经得到了改善。这包括对无障碍色彩的更新,对代码块视觉对比的加强,以及可分类的表格。这些更新很小,但很重要--你可能只有在它们工作不正常的时候才会注意到它们。

考虑到这一点,如果你在我们的文档中发现一个可用性错误,请提交一个问题

CockroachDB文档中的浏览器交互式SQL Shell

An interactive SQL playground in CockroachDB

我们的文档中新增了一个非常令人兴奋的功能,那就是我们新的浏览器内交互式SQL shell,也被称为 "SQL Playground"。这个游乐场为你提供了一个单节点CockroachDB集群的交互式SQL shell,并预装了一个样本数据集。这将允许你在进入 "真实 "的东西之前在你的浏览器上测试功能。

我们现在还提供互动教程,作为SQL Playground中更多的指导性经验。

再见,绿色。刷新我们的品牌形象

CockroachDB Docs site before and after navigation improvements

最后,我们的品牌形象已经全面更新。我们对此感到非常兴奋。我们的新颜色、字体和图像都非常漂亮,你可以在我们的主网站上进一步探索。除了视觉上的更新,我们还增加了一个新的UI(用户界面)组件库,用于整个网站。这包括按钮、字段、导航条、呼出等。现在,我们对这些组件的造型和使用是一致的,这不仅使我们的用户有一个凝聚力和一致的体验,而且也使我们的工程团队更容易维护它。

我们欣赏的文档网站

你可能想知道我们是如何确定要改变什么的。和许多设计项目一样,我们一开始就做了研究。我们与我们的同事和用户联系,了解他们喜欢或不喜欢网站的什么,他们如何通过导航来找到他们要找的内容,以及他们希望得到什么功能。我们希望确定用户在访问文档网站时的需求,以便我们能够为这些需求设计解决方案。我们还分析了其他公司的文档网站--如MongoDBStripe--我们认为是成功的,并批判性地评估了我们喜欢它们的原因所在。然后,我们开始了设计探索,测试不同的原型(从低保真草图到高保真演练),直到我们找到了最终的概念。

可用性测试

在整个测试过程中,我们特别注意确保用户在浏览文档网站时感到有方向感,并优先考虑快速定位内容的能力,同时仍有一个愉快的阅读体验。

我们非常高兴最终与大家分享这些更新,因为我们知道,虽然这将是一个重大的改进,但好的设计永远不会停止。在重新设计后的几个月里,我们将监测我们的CSAT分数,页面分析,并收集定性反馈,以了解我们的用户对更新的反应,并衡量事实上我们的目标是否已经实现。在未来,我们将使用这些指标和定性反馈来推动下一步和未来的改进,包括令人兴奋的更新,如黑暗模式,改进的搜索体验,以及更多。敬请关注

为CockroachDB的文档做出贡献

我们的文档是开源的,我们鼓励任何人通过贡献内容、测试例子和教程,或者提出改进建议的问题来帮助改进文档。