- 预审中
- 预审通过
- 3 已采纳
- 4 已实现
【用户体验】【产品&文档体验优化活动】DME帮助文档的搜索功能体验不佳,难以快速定位API文档 已采纳 编辑 删除
- 工业软件
- 工业数字模型驱动引擎iDME
场景描述:
我是一名正在进行应用开发的开发者,需要将我们的系统与华为云DME平台进行对接,因此频繁需要查阅相关的API接口文档。当我尝试在DME的帮助文档中心(https://support.huaweicloud.com/dme/index.html)搜索具体的API时,例如我想查找“设备属性上报”或“查询设备影子”相关的接口,我使用了“属性上报”、“查询影子”等关键词进行搜索。然而,搜索结果列表的前几页基本都是产品介绍、开发指南或常见问题(FAQ)等宏观的文档,我需要手动翻到很后面才能找到我需要的具体API参考文档,或者有时根本找不到,最后只能在左侧导航栏中逐级展开目录来寻找。这个过程非常耗时,严重影响了开发效率。
建议方案:
我提出以下三点建议:
优化算法搜索权重:建议调整文档搜索引擎的算法,提高“API参考”或“接口文档”这类技术文档的搜索权重。当用户的搜索词包含“API”、“接口”、“调用”、“参数”等开发常用词时,应优先将相关的API文档展示在搜索结果的顶部。
增加智能标签:为每一篇API文档添加更丰富的、语义化的标签。例如,对于“查询设备影子”的API,可以添加“设备影子”、“查询”、“Device Shadow”、“Query”、“API”等中英文标签。这样即使用户搜索的不是文档标题中的确切词语,也能通过标签匹配到正确的结果。
引入API专用搜索筛选器:在搜索结果页面增加一个“文档类型”的筛选器(例如:全部、API参考、开发指南、最佳实践、FAQ)。这样,当我想专门查找API时,我只需点击“API参考”筛选器,就可以立即过滤掉所有其他类型的干扰文档,从而实现快速、精准的定位。
相关链接:https://support.huaweicloud.com/consog-idme/idme_consog_0099.html
yd_281942979
发布于 2025-09-20 13:43:44
2025-09-20
47 2
0/1000
仅支持JPG、JPEG、PNG、GIF,数量不超过4张且每张大小不超过2MB
删除建议
全部评论(2)
评论(2)
您好,经与iDME文档相关团队确认,该产品文档不涉及设备影子等内容,您可以通过文档左侧的导航栏筛选API。
如果需咨询文档内容,推荐您在官网搜索输入详细问题,使用AI搜索知识问答功能。感谢您的建议和对华为云的支持,祝您生活愉快!
非常感谢您的反馈,您的建议和诉求已经收到,并已提交至相关产品团队进行核查评估,评估完成后对于建议是否采纳会尽快给您答复,也请您持续关注云声平台,了解反馈建议处理进展,感谢您对华为云的支持!