共计 3055 个字符，预计需要花费 8 分钟才能阅读完成。
欢送拜访 OceanBase 官网获取更多信息：https://www.oceanbase.com/
自 2020 年 OceanBase 以独立子公司开始全面推动商业化以来，提供更好更易用的数据库文档始终是 OceanBase 致力的一个重要方向。
如何通过文档让用户更疾速更便捷地理解和应用 OceanBase 数据库？如何辅助用户更疾速地解决应用过程中遇到的问题？是 OceanBase 文档始终在摸索和前行的方向。
过来的两年里，咱们收到了很多数据库爱好者对 OceanBase 文档的反馈和“吐槽”，也走进来和很多数据库使用者和专家进行了很多交换。 文档有然而不能解决问题、文档有然而找不到、文档缺失等 是让用户头大的几大问题，给用户自助应用带来了掣肘。面向越来越多的数据库爱好者自助学习和应用数据库的大背景，带着用户的声音和期待，咱们启动了 OceanBase 文档易用性演进。
在这期间，咱们也始终在思考几个问题，文档如何能更合乎用户的诉求能真正提供帮忙、文档如何能更易用、文档如何能继续的演进和迭代。咱们认为文档须要凝听用户实在的声音，须要越辩越明，须要集思广益，咱们要做更 open 的文档。
咱们最近做了什么？
近期，联合着 OceanBase 数据库 4.x 的新架构，OceanBase 针对文档做了很多探讨，联合之前大家反馈的一些文档倡议和问题，对文档和文档核心做了一些调整，在文档内容上也更多地去贴近用户视角和场景。
▋ 解决文档「不好找」的问题，文档更聚焦，20% 的文档笼罩 80% 的问题
作为一款较简单的软件，咱们须要提供大量的文档来满足用户在不同场景下的信息获取诉求，这些文档包含操作领导、技术原理介绍、参数 / 视图 / 错误码等参考类信息。文档丰盛能够确保用户想要的信息都有，然而随之带来的问题是如何更好的组织这些信息，能力让用户在这么多信息中比拟快捷比拟精准的找到本人须要的。
之前 OceanBase 文档将面向同一用户角色的各类信息（操作领导、技术原理、参考信息等）做汇聚来对立出现，力求出现更全的信息。 信息全，然而同时也带来了不小的信息“烦扰”，信息查找艰难， 这些庞杂的信息中，可能只有大量是大部分用户在日常工作中高频会查阅的信息，残余的大量信息用户次要是以按需查找为主。
在这一次的调整中， 咱们协同 OceanBase 数据库的资深 DBA 一起重复探讨和梳理出了用户应用 OceanBase 数据库的外围链路和场景，将这些外围链路和场景的相干文档依照用户旅程来独自出现。 同时将用户按需检索类的文档作为参考信息独自出现，对文档信息依照用户角色和内容类型做了分层解决，文档更轻量，定位更清晰。
▋ 解决文档「不好用」的问题，文档更加用户视角和场景化
以前用 OceanBase 文档的时候是不是会有点什么都写了，又如同没写什么的感觉。咱们深刻分析了一下，次要是因为之前的文档没有和用户的“语言”同频。之前的文档比拟偏差性能视角，在更多的去通知大家咱们有什么，然而用户日常的门路是我遇到了什么问题应该怎么去解决。
在这次的调整中，咱们着重向用户视角和场景化的大方向上演进，文档更重要的去讲述咱们可能解决什么问题。“是什么、为了什么 / 解决什么、什么时候 / 什么场景下应用、如何应用（提供具体的应用 demo 和阐明）、留神什么、如何验证”，更贴近用户的应用思路和理论场景，务求可能真正提供帮忙。
🌟以隔离节点为例
▷ 为什么须要隔离节点？
▷ 什么状况下须要隔离节点？
▷ 隔离节点的逻辑？
▷ 如何隔离节点？
▷ 具体的操作信息和实用场景
▷ 必要的危险提醒和应用倡议
内容好很重要，内容便于应用也很重要。 在优化文档内容的同时，咱们也针对大家应用 OceanBase 文档过程中遇到的体验问题进行了小小的调优，以晋升文档核心应用体验，进一步解决用户痛点问题。
▋ 解决文档「找不到」的问题，提供更多的文档应用疏导
OceanBase 除了分布式数据库之外，还提供了丰盛的生态工具产品来辅助用户更好更便捷地应用数据库，这些产品都有配套文档，然而之前文档核心没有提供明确的入口，这些文档对于用户来说可能是“不可见”的。
OceanBase 提供了很多内容，除了产品版本配套的应用文档之外，也会提供面向不同用户角色不同应用场景的教程和视频类内容，然而这些内容都暗藏在了 OceanBase 大量的文档中，对于用户来说可能也是“不可见”的。
针对这些“不可见”的问题，咱们在文档核心提供了文档“大地图”，用户能够依据文档导览图疾速看到都有哪些内容可用并疾速中转。
▋ 解决文档「不好搜」的问题，搜寻后果可筛选，搜寻分层更精准
OceanBase 的文档很多，搜寻范畴的精准性对于疾速找到想要的内容至关重要。
咱们在之前的用户访谈中，重复听到用户对于疾速精确查找到想要文档的痛点，“文档不是没有，然而不容易找到”、“搜寻后果里，有很多同名文档，点进去才发现不是本人想看的版本”等等等等。
针对搜寻后果“太多”的问题，咱们提供了搜寻后果筛选的能力，大家能够通过抉择想要的产品和版本来放大搜寻后果的范畴。
针对如何晋升站内搜索精准度的问题，咱们对搜寻做了分层解决，当初您能够搜整个官网一览所有内容，也能够专一搜寻文档，还能够更加精准的搜某个产品某个版本的文档，搜寻范畴可泛可精准，满足不同场景的诉求。
除了上述调整之外，咱们还针对文档的导航目录、文档的款式等做了很多细小的调优，欢送到 OceanBase 文档核心体验这些小而美的改良。
🌟更多小的体验晋升
▷ 性能更易用
▷ 文档切换、PDF 下载、文档反馈等性能更显著，应用门路更清晰
▷ 更丰盛的文档款式
▷ 设计了更多文档款式，让信息获取更便捷
与咱们一起共建更易用的数据库文档
OceanBase 始终置信更好的数据库文档肯定来源于酷爱数据库的大家们的独特打磨和建设。后续咱们将以文档晋升流动、文档专家小组、主题性文档探讨等模式陆续发动 OceanBase 文档共建流动，和大家一起打磨更好用的数据库文档。
▋ 一起交换呀，文档越磨越易用
同步一个小流动，近期，OceanBase 4.0 文档和文档核心都进行了一些调整，咱们诚邀大家一起来体验试用：
您能够给咱们的文档提交 pr，反馈在应用过程中的各种问题；也能够在社区文档帖子下反馈倡议，跟帖互动，碰撞交换。 咱们将针对优质反馈赠送定制键盘、Polo 衫、定制无线充等精美礼品和社区积分喔～感兴趣的小伙伴能够点击链接（https://ask.oceanbase.com/t/topic/35602746）查看具体的流动细节。
▋ 文档专家小组，文档的智囊团
文档须要长期的建设和继续演进，咱们也会把文档共建作为一个长期的打算来推动。为了更好的撑持文档共建的运作，构建更 open 的数据库文档，OceanBase 拟筹建文档专家小组。文档专家小组后续会深度参加到 OceanBase 文档的共建、文档策略探讨、和文档演进中来。
更多文档专家小组的建设和运作机制的细节信息，咱们后续会在 OceanBase 官网和社区透出，期待您的关注和参加。
写在最初
咱们赶上分布式数据库的大潮，也遇上了数据库学习和应用的热潮，构建更好的数据库文档，服务更多的数据库爱好者和使用者，让咱们一起共建更易用的数据库文档，让文档施展更大的价值。
最初，墙裂倡议钉钉扫码退出咱们的钉钉群（群号：41203246），本群为咱们文档奉献社区官网交换群，OceanBase 文档同学将在群里实时互动答疑，同步流动积分和最终后果，并为您解决流动中遇到的各种问题~🎉
欢送拜访 OceanBase 官网获取更多信息：https://www.oceanbase.com/