关于文档的那些“吐槽”,我们的解决方案是这样的

首先,感谢开发者们往年,通过我们各种形式的活动,参与反馈开发文档意见,比如问卷、文档找茬活动、吐槽会等。今年,我们的 SDK 文档团队采访了多位开发者,在视频的一端,我们收了今年份的“吐槽”。

感谢蒋著、李世达、李世辉、姚苍力、余彦臻、于卓浩等开发者们给出的大量建设性反馈,比如快速开始不够“快”、缺少错误码解释、内容结构不够清晰等。其中有些问题,可能“在读”的各位也遇到过。

经过内部的讨论,我们会优先解决一些问题。所以接下来,我们的重点工作会有这些:

  • 重构快速开始。针对多人反馈快速开始过于冗长的问题,计划将快速开始拆分为跑通 Demo、集成 SDK、实现基础功能三篇,方便带不同目的的开发者迅速找到文档入口,同时在步骤描述中,重指导,轻描述。

  • 添加“如何集成第三方 SDK 或服务”的文档部分。目前,部分场景需接入 FaceUnity 或白板,对用户来说是个难点,计划增加补充这部分的文档。

  • 调整进阶功能的架构和内容。现有的进阶功能可以拆分为“常用功能”和“高阶功能”,方便用户根据自己的水平选择文档阅读。同时,各功能会匹配新的 API-example 示例项目。

  • 定期从开发者论坛中选取用户提问率高的问题及方案,补充到 FAQ 文档中。

  • 错误码文档中,补充报错原因,以及解决办法。

  • 针对自动化工具生成的 API 文档版面不好看等问题,首先会从 UI,以及网站适配方面想办法提高易用性,后续会从其它层面做更多优化。

另外,我们还收到了有一些很好的建议,比如说希望在网页上通过一些按钮交互来了解遇到的集成问题在哪。我们的文档与产品团队已经在综合评估中了。

最后,再次感谢参与本次线上文档吐槽会开发者们。我们会不断改进文档和网站。如果各位开发者在阅读、使用文档的过程中遇到任何问题,欢迎登录 RTC 开发者社区(rtcdeveloper.com)吐槽,笔芯。

你可能感兴趣的:(编程语言,css,javascript,java,敏捷开发)