Dubbo 3 是 Dubbo 新的里程碑，Dubbo 的生态组件（包含 Dubbo Java SDK，Dubbo Golang SDK 等）都在向 Dubbo 3 的方针靠拢，在用户实践方面，包含阿里巴巴、淘宝、天猫、饿了么、工商银行、平安健康等企业都已成功晋级 Dubbo 3 版别，跟着更多的企业和用户重视或晋级 Dubbo 3，整个社区对 Dubbo 3 的文档的需求初步变得愈加迫切，以帮助用户正确运用 Dubbo 3 功用或知道怎么排查遇到的问题。
为了进步 Dubbo 3 文档的质量，Dubbo 社区在 6 月份中旬的时分发出了《Dubbo 3 官方文档贡献者召集令》。这两个月以来，Dubbo 官网收到了近 250 个 Commit，正是由于有了社区各位同伴的积极贡献，Dubbo 官方文档的结构和内容有了许许多多的改动。
apache/dubbo-website 提交活跃度
本次体会优化聚焦的重视点
1. 文档全面对齐最新 Dubbo 3 版别
Dubbo 3 作为 Dubbo 的一个里程碑版别，做了许多的优化和架构调整。在本次文档优化中，咱们重点重视了这部分的文档问题，补充完善了 Dubbo 架构调整的内容、全新的应用级服务发现模型和 Triple 协议等的说明运用文档。别的咱们也对一些快速初步用例和已有功用的文档做了必定的优化调整，来对齐 Dubbo 3 版别。
2. 文档架构优化，抽离出面向新手的入门文档
本次体会优化的过程中，咱们把原有的文档拆分为入门文档和 SDK 文档两个部分。面向 Dubbo 的入门用户，在入门文档模块能够快速了解什么是 Dubbo、Dubbo 3 的新特性、快速初步运用 Dubbo、根据场景示例的实践等。和入门文档模块与之对应的是 SDK 手册，SDK 手册中存放了各个 SDK、东西的文档，包含了 Java SDK、Golang SDK、Dubbo Go Pixiu 等，面向想要深入了解各个 SDK 的用户。
除了全体架构的分级，咱们也对 Java SDK 中一些子目录的结构进行了优化，如高档特性和用法目录下按照不同的场景别离出流量治理、确诊与调优、进步安全性等子目录。
入门文档部分
SDK 手册部分
3. 查找
Dubbo 作为一个 RPC 底层结构，提供了许多的功用，为了讲清楚功用怎么用、装备怎么配、原理是怎么样的等问题，规划了许多的文档。当时 Dubbo 的总文档数达到了一千多篇，纵使文档架构再怎么优化，大部分用户也无法很快定位到具体的一篇文档。为了处理这个问题，咱们引入了 Algolia 查找东西，优化了对应的文档抓取逻辑，期望用户能够通过关键字查找快速找到所需求的文档。
Algolia 查找结果示例
4. 多语言生态
在 Dubbo 的发展规划中，多语言生态是一个重要的组成部分，各个语言子社区都是 Dubbo 不可别离的一个部分。在本次文档体会晋级的过程中咱们也将各个子社区分散的文档进行了整合，目前大部分的文档都现已搬迁到了 SDK 手册中，入门文档的部分示例也和 Golang SDK 联合做了适配。
5. 反常链接修正
Dubbo 官网在历史上经历过好几个版别的大的迭代，许多网页的跳转链接存在着失效的问题，给阅读者带来了很不好的体会。在 dubbo-website 的 issue 列表中也有许多关于外链失效的反馈。为了从根本上处理这个问题，咱们在 GitHub Actions 作业流中引入了根据 htmltest 的链接校验逻辑，在每次提交的时分都会检查页面上的链接是否都还是有效，假如失效的话会有对应的报错陈述，以此来确保跳转都是有效的。在第一次全体调整的过程中，咱们一共修正了 600+ 个链接失效问题。
规划中的内容
1. Dubbo 3 源码导读
Dubbo 3 作为 Dubbo 的里程碑版别做了许多的技能架构调整，为了让社区的小同伴更容易理解 Dubbo 的原理规划，Dubbo 社区在规划完成新版的代码导读系列，预计在近期会和大家见面。
2. 运用 FAQ 文档
Dubbo 作为一个 RPC 结构，和开发态、运维态的作业都极为严密，在运用 Dubbo 的过程中不免会遇到非预期的报错，可是苦于对源码不够了解无法进行高效的排查。Dubbo 3 将全新晋级 FAQ 文档机制，在报错的时分自动链接到官方文档中对应的 FAQ 文档，进步反常的排查功率，进步全体运用体会。
写在最终
本次文档的优化只是 Dubbo 在易用性体会优化上的一个初步，由于 Dubbo 官方文档的数量许多，不免存在遗漏的地方，咱们欢迎大家继续对包含 Dubbo 官方文档在内的 Dubbo 易用性体会提出问题主张（直接提交 issue 就能够啦）。在未来咱们也将继续投入在 Dubbo 易用性优化的部分上，让 Dubbo 能被更多的人更容易地用上、用好。
点击此处，直达 Dubbo 官网。
