从解决问题到用户共建，为了进步，OceanBase文档都做了哪些努力？

一款数据库产品，如何让数据库爱好者能够实现更好的自助学习和使用？使用说明书（文档）至关重要。而为了让用户更快速更便捷地了解和使用 OceanBase 数据库，更好地辅助用户更快速地解决使用过程中遇到的问题，OceanBase文档于日前进行了全新调整。

解决4个关键问题

据悉，OceanBase结合数据库 4.x的新架构，以及用户反馈的一些文档建议和问题，对文档和文档中心做了相应的调整，解决了文档现存的4大问题。

首先，大量的文档在丰富用户所需信息的同时，也带来了无法精准查找的难题。为此OceanBase 的数据人员经过反复讨论，梳理出了用户使用 OceanBase 数据库的核心链路和场景，将这些核心链路和场景的相关文档按照用户旅程来单独呈现。同时将用户按需检索类的文档作为参考信息单独呈现，对文档信息按照用户角色和内容类型做了分层处理，文档更轻量，定位更清晰。

其次，由于之前的文档没有和用户“语言”同频，经常导致用户问题无法解决。为此，OceanBase文档着重向用户视角和场景化的大方向上演进，文档更重要地去讲述能够解决什么问题。“是什么、为了什么/解决什么、什么时候/什么场景下使用、如何使用（提供详细的使用 demo 和说明）、注意什么、如何验证”，更贴近用户的使用思路和实际场景，务求能够真正提供帮助。

再者，因为文档中没有生态工具产品的明确入口，并且面向不同用户角色不同使用场景的教程和视频类内容会被隐藏，所以很多内容对于用户来说是“不可见”的。因此，OceanBase在文档中心提供了文档“大地图”，用户可以根据文档导览图快速看到都有哪些内容可用并快速直达。

最后，因为OceanBase 的文档过多，用户很难精准搜索，经常出现“文档不是没有，但是不容易找到”等问题。为此，OceanBase提供了搜索结果筛选的能力，让大家可以通过选择想要的产品和版本来缩小搜索结果的范围；对搜索做了分层处理，现在可以搜整个官网一览所有内容，也可以专注搜索文档，还可以更加精准的搜某个产品某个版本的文档，搜索范围可泛可精准，满足不同场景的诉求；同时对文档的导航目录、文档的样式等做了很多细小的调优。

诚邀用户共建更好用的数据库文档

为了建设更好的数据库文档，OceanBase还将以文档提升活动、文档专家小组、主题性文档讨论等形式陆续发起 OceanBase 文档共建活动，诚邀大家一起打磨更好用的数据库文档。

比如，OceanBase 4.0 文档和文档中心都进行了一些调整，因此OceanBase会邀请大家一起体验试用。可以通过给文档提交 pr，反馈在使用过程中的各种问题；也可以在社区文档帖子下反馈建议，跟帖互动，碰撞交流。OceanBase将针对优质反馈赠送定制键盘、Polo衫、定制无线充等精美礼品和社区积分。

再比如，因为文档需要长期的建设和持续演进，所以OceanBase会把文档共建作为一个长期的计划来推进。为了更好地支撑文档共建的运作，构建更 open 的数据库文档，OceanBase 拟筹建文档专家小组。文档专家小组后续会深度参与到 OceanBase 文档的共建、文档策略讨论、和文档演进中来。

可以说，我们这代人赶上了分布式数据库的大潮，也遇上了数据库学习和使用的热潮，而更好的数据库文档，无疑能够服务更多的数据库爱好者和使用者。也期待OceanBase文档之后能实现更华丽的蜕变。