一、昇腾文档内容持续改进
1、文档正确性问题
文档正确性问题通常是资料中遇到的拼写错误、链接失效、内容不完整等影响开发者基本阅读的问题，2024年我们通过上机验证、工具低错检查、加强测试等方法进行问题闭环及持续规避。典型问题如下：
2、文档可用性问题
这类问题主要是资料中缺少某关键步骤及参数、写作内容不容易理解、写作不规范等，导致用户没办法流畅的依据资料进行开发。2024年提出的文档可用性问题我们均已单点闭环，并通过定期开展上机验证及抓虫活动、设置内容可用性checklist等方法持续性改进。典型问题如下：
3、文档易用性问题
文档缺少更丰富的样例和快速入门、场景覆盖不全等均属于文档易用性问题，在单点闭环问题的同时，通过系统化的场景机制由点及面解决共性问题，持续努力做到让不同开发水平、不同开发场景需求的用户都能上手产品。典型问题如下：
二、昇腾文档中心持续改进
- 针对开发者反馈的“固件驱动+CANN”安装困难问题，安装文档通过内容场景化改造，在社区提供场景化筛选能力，文档查阅规模从100+降低到20以内（2024年8月上线）。体验链接
- 为帮助开发者快速查找文档，文档中心首页新增场景化筛选能力、单文档节点增加场景分类功能，缩小文档获取的范围，提升效率（2024年9月上线）。体验链接
- 在文档浏览与反馈方面，文档中心在多端适配、内容版面布局、求助与反馈、分屏阅读、搜索结果分类等方面持续根据开发者VOC进行迭代优化（2024全年）。
三、总结
2025年，我们会持续在以下方面提升文档质量和易用性：
- 持续提升文档阅读体验，如代码块显示、文档单页/连续页浏览；
- 加强内部测试、跳伞、抓虫等活动，对社区关键文档、Gitee开源文档进行质量加固；
- 丰富案例库，提供更多的场景化案例内容；
- 探索大模型在文档使用过程中的应用（如智能伴读）。
欢迎大家提供25年文档改进方向以及优化建议，期待更多优秀的声音让昇腾文档更易用！
点赞
收藏
回复
分享
举报
一、昇腾文档内容持续改进
1、文档正确性问题
文档正确性问题通常是资料中遇到的拼写错误、链接失效、内容不完整等影响开发者基本阅读的问题，2024年我们通过上机验证、工具低错检查、加强测试等方法进行问题闭环及持续规避。典型问题如下：
序号
问题描述
问题类型
1
MindIE中应该为metrics的port，而非management port。
内容错误
2
日志中未找到Warning级别预警。
内容不完整
3
加速库BLAS算子库的查看详情跳转的不对。
链接失效
2、文档可用性问题
这类问题主要是资料中缺少某关键步骤及参数、写作内容不容易理解、写作不规范等，导致用户没办法流畅的依据资料进行开发。2024年提出的文档可用性问题我们均已单点闭环，并通过定期开展上机验证及抓虫活动、设置内容可用性checklist等方法持续性改进。典型问题如下：
序号
问题描述
问题类型
1
PyTorch安装中上一步未生成whl包，无法继续安装。
按文档指引操作失败
2
文章中“说明”和“须知”混用，两者有什么区别？不好理解 。
写作不规范
3
“maxBatchSize-1”的内容不容易理解，建议更改描述。
文档内容不易理解
3、文档易用性问题
文档缺少更丰富的样例和快速入门、场景覆盖不全等均属于文档易用性问题，在单点闭环问题的同时，通过系统化的场景机制由点及面解决共性问题，持续努力做到让不同开发水平、不同开发场景需求的用户都能上手产品。典型问题如下：
序号
问题描述
问题类型
1
为什么把Caffe场景的离线模型dump放在NPU vs NPU场景？
文档信息架构不合理
2
ATB算子部分api缺少demo指导。
文档内容丰富度
3
PyTorch训练迁移哪里有混合精度相关的内容？
场景缺失
二、昇腾文档中心持续改进
三、总结
2025年，我们会持续在以下方面提升文档质量和易用性：
欢迎大家提供25年文档改进方向以及优化建议，期待更多优秀的声音让昇腾文档更易用！