一款数据库产品,如何让数据库爱好者能够实现更好的自助学习和使用?使用说明书(文档)至关重要。而为了让用户更快速更便捷地了解和使用OceanBase数据库,更好地辅助用户更快速地解决使用过程中遇到的问题,OceanBase文档于日前进行了全新调整。
解决4个关键问题
据悉,OceanBase结合数据库4.x的新架构,以及用户反馈的一些文档建议和问题,对文档和文档中心做了相应的调整,解决了文档现存的4大问题。
首先,大量的文档在丰富用户所需信息的同时,也带来了无法精准查找的难题。为此OceanBase的数据人员经过反复讨论,梳理出了用户使用OceanBase数据库的核心链路和场景,将这些核心链路和场景的相关文档按照用户旅程来单独呈现。同时将用户按需检索类的文档作为参考信息单独呈现,对文档信息按照用户角色和内容类型做了分层处理,文档更轻量,定位更清晰。
其次,由于之前的文档没有和用户“语言”同频,经常导致用户问题无法解决。为此,OceanBase文档着重向用户视角和场景化的大方向上演进,文档更重要地去讲述能够解决什么问题。“是什么、为了什么/解决什么、什么时候/什么场景下使用、如何使用(提供详细的使用demo和说明)、注意什么、如何验证”,更贴近用户的使用思路和实际场景,务求能够真正提供帮助。
再者,因为文档中没有生态工具产品的明确入口,并且面向不同用户角色不同使用场景的教程和视频类内容会被隐藏,所以很多内容对于用户来说是“不可见”的。因此,OceanBase在文档中心提供了文档“大地图”,用户可以根据文档导览图快速看到都有哪些内容可用并快速直达。
最后,因为OceanBase的文档过多,用户很难精准搜索,经常出现“文档不是没有,但是不容易找到”等问题。为此,OceanBase提供了搜索结果筛选的能力,让大家可以通过选择想要的产品和版本来缩小搜索结果的范围;对搜索做了分层处理,现在可以搜整个