飞桨框架体验评测是由PPSIG DOCS小组发起，专注于提升飞桨框架开发体验的开源共建活动。自2022年2月活动启动以来，评测小组以飞桨框架文档（包含API文档、使用指南、Github Docs等文档）为评测重点，覆盖单机训练、部署、硬件、分布式等重点方向，提升飞桨框架开发体验的同时，共同探索通过社区合作共建飞桨框架的开源协作新模式。

目前飞桨框架体验评测一共开展了6期活动，累计超过120位体验评测官参与框架开源共建，提交了520个issue、73个PR和475篇评测报告。其中第三季度开展了2期活动，涉及：

• API文档的质量评测、问题发现和修复优化；

• 框架动态图转静态图的使用教程文档质量评测；

• 分布式操作使用类文档顺畅度评测；

• 用户安装的软硬件环境调研及问题优化。

  
  

针对以上产品方向的文档和使用教程，评测官们反馈了大量关于飞桨框架使用体验和文档建设的宝贵建议，对飞桨框架产品建设提供建设性的思路。

更值得一提的是，除了积极建言以外，有不少评测官主动提交PR修复文档问题，相关成果已被合入到飞桨框架v2.4中，即将正式服务于广大开发者。

第三季度评测成果

及对使用体验的贡献

文档易读性

• API文档评测与优化

文档团队在本季度进一步推进API文档修复工作，共修复300篇API文档。为验证修复效果，体验评测小组从已修复的API文档中随机抽取30篇文档，并邀请众多测评官对30篇文档进行质量评估。整体上，重点API文档质量得到有效保障（评测官评分由64.8分提升至86.2分），其中，文档团队重点修复了评测员反馈的部分示例代码运行不畅、参数描述中英文语法不准确、返回值遗漏或不一致、超链失效等易读性体验问题。后续，文档团队将对API文档进行持续性优化，及时修复问题，进一步提升API文档的质量。

• 动态图转静态图使用指南

文档团队在本季度对动转静文档的逻辑、结构、用词和内容等方面都做了大幅修改。为验证修复效果，体验评测小组邀请众多评测官对优化后的5篇动转静文档进行全面评估。整体上，优化后的动转静文档取得了评测官的良好反馈（每篇文档的评分均超过90分）。其中，评测官对文档的逻辑和用词评价较高，对部分文档的内容和结构提出了众多建议。具体的统计结果显示，评测员一共提交PR 19个、issue 3个，包含了90多条建议。经文档团队筛选并总结出5类超过30条有效建议，包括内容修复、书写格式、配图优化、补充描述、增加文档趣味性等。文档团队后续将及时修正用户反馈的问题，以进一步提升动转静文档的易用性。

使用顺畅性

• 分布式快速使用文档

分布式快速使用文档对于开发者们一直是痛点所在。在往期评测活动中，体验评测小组发现参数服务器的快速使用文档存在严重问题，其中数据加载的部分是问题重灾区。分布式团队在本季度对文档进行内部紧急修复，文档全流程使用顺畅性得到了极大提升。评测官根据文档将单机转写参数服务器的任务打卡成功率，由65%提升至100%，验证了文档的修复成果。

飞桨框架依赖库和环境兼容性

为了扩大飞桨框架对主流依赖库的适配度和众多系统及软件环境的兼容性，提升用户的下载安装体验。体验评测小组向40名评测官发起邀请，收集系统及软硬件环境使用情况，作为环境分布支持情况的参考。同时提炼了2个用户安装及编译的需求——适配Windows11、支持VS code2022，后续将进行内外部联合并支持优化。

飞桨框架

体验评测交流会

7月28日，首期飞桨框架体验评测交流会线上举办，引发热烈反响。为了传递飞桨框架体验评测最新工作成果，同步体验评测项目未来计划，更好地了解大家的切实需求和使用体验，从而提升飞桨框架文档的易用性。我们将于10月16日，以线上+线下的形式，举行第二期飞桨框架体验评测交流会，与大家共同探讨文档未来的改进方向。期待大家宝贵的意见和建议，一起让飞桨框架变得更好!

上季度评测活动，涌现出6位优秀的评测官：阿太、净好、讷言敏行、晓光、反折耳根战士、追云戏月，在本次评测交流会中将邀请晓光、净好、反折耳根战士、阿太（暂定）为大家分享产品使用经验及建议。

活动时间

10月16日（周日）14:00——15:30

活动地点

线上会议：社群内通知（文末扫码入群）

线下地点：百度大厦

活动议程

环节一 ：《飞桨框架体验评测第三季度回顾、目标与未来新规划》

分享人 ：飞桨框架产品经理 孙钟恺

环节二 ：《优秀评测官分享》

分享人：卢继光（晓光）、张光浩（净好）、刘金源（反折耳根战士）、渠性太（阿太）

• 优秀评测官介绍

参与方式

拓展阅读

飞桨框架体验评测交流会，产品的使用体验由你来决定！

关注【飞桨PaddlePaddle】公众号

获取更多技术内容~