文章目录
- 前言
- 一、文档中心的外链跳转问题
- 1.1、问题描述
- 1.2、造成的问题
- 1.3、改进建议
- 二、图片失真和无法放大查看问题
- 2.1、问题描述
- 2.2、造成的问题
- 2.3、改进建议
- 三、个别 SDK 词汇缺少必要的说明
- 3.1、问题描述
- 3.2、造成的问题
- 3.3、改进建议
- 四、邮箱信息的优化
- 4.1、问题描述
- 4.2、改进建议
- 五、非浏览器客户端打开的文档兼容问题
- 5.1、问题描述
- 5.2、造成的问题
- 5.3、改进建议
- 六、导航栏——应用市场(AppGallery Connect)角色与权限多次跳转的问题
- 6.1、问题描述
- 6.2、造成的问题
- 6.3、改进建议
- 七、部分文档无法下载需至详情页下载
- 7.1、问题描述
- 7.2、造成的问题
- 7.3、改进建议
- 八、信息时间描述的不规范性
- 8.1、问题描述
- 8.2、造成的问题
- 8.3、改进建议
- 总结
- 后续
前言
应邀参与对华为开发者联盟基础服务文档提出修改建议,我整体对文档浏览了一遍,整理出如下 8 条可能需要完善的地方,综合问题描述以及造成的问题给出了我个人的优化建议。如有不足请多多指正。
一、文档中心的外链跳转问题
1.1、问题描述
- 参考文档附的参考链接,仅仅是在本页面进行跳转,并不是打开新的窗口。
1.2、造成的问题
- 用户浏览参考文档的链接内容,但是丢失了之前的导航索引对象。
- 如果要浏览之前的对象,只能后退页面重新加载,耗费用户时间。
- 用户体验较差。
1.3、改进建议
- 打开新的链接应该是从新的窗口打开,这样用户在浏览参考文档的内容的同时不会丢失之前的浏览对象。提升用户浏览文档的体验。
二、图片失真和无法放大查看问题
2.1、问题描述
- 个别图片处理失真,打开图片之后根本无法看清。同时图片无法放大查看其内容。
2.2、造成的问题
- 用户无法根据图片提示来完成相应操作。
- 图片提示的作用丧失。
- 起不到作用的东西属于消耗文档内存资源。
- 文档用户体验较差。
2.3、改进建议
- 将上传的图片清晰度提高。
- 增加图片放大查看功能。
三、个别 SDK 词汇缺少必要的说明
3.1、问题描述
- SDK 索引页缺少对 SDK 必要的信息描述。
3.2、造成的问题
- 用户无法快速得知某个 SDK 的信息描述以及介绍。
3.3、改进建议
- 对 SDK 及其能力增加简要描述信息。
四、邮箱信息的优化
4.1、问题描述
- 邮箱信息仅为邮箱信息,无法实现快速跳转发送邮件的功能。
4.2、改进建议
- 添加为邮箱链接。
五、非浏览器客户端打开的文档兼容问题
5.1、问题描述
- 使用非浏览器客户端打开文档链接,例如微信打开链接,使用内置浏览器加载存在下方两个块消失的问题(语言选择、联系我们、版权信息等)。
进入开发者模式可以看到不显示的两个 div。
5.2、造成的问题
- 使用非浏览客户端查看该文档存在巨大问题,非中文语言用户无法切换语言选项,无法联系到“我们”,无法查看版权信息。
5.3、改进建议
- 增加对非浏览器客户端的兼容支持。
- 测试多个浏览器客户端与应用内置浏览器内核,可能还会存在其他问题。
- 文档添加如“使用360浏览器打开”的说明语。
六、导航栏——应用市场(AppGallery Connect)角色与权限多次跳转的问题
6.1、问题描述
- 应用市场(AppGallery Connect)角色与权限点击参考链接跳转至明细页面后缺少权限图。
- 了解某个角色所处的位置只能返回之前页面进行查看。
6.2、造成的问题
- 根据美国心理学家乔治·米勒提出的 7±2 效应,成人短时记忆的容量为 7±2,即一般为7并在 5~9 之间波动。用户无法记忆清楚某个角色在图中所处的位置,需要反复查看。
- 多次查看降低用户查看积极性,促使用户不愿意再详细了解具体内容,用户体验较差。
- 反复查看浪费用户大量时间。
6.3、改进建议
- 在管理团队帐号——附录:角色与权限详情页添加应用市场(AppGallery Connect)角色与权限图。
- 参考“流量变现服务角色与权限”改进。
七、部分文档无法下载需至详情页下载
7.1、问题描述
- 部分文档在描述页虽标明点击下载,但是仍需要至参考文档中去下载。
7.2、造成的问题
- 文档下载不统一,页面体验较差。
- 无用内容造成的文档资源浪费。
7.3、改进建议
- 统一在标明“点击下载”的文件中附上下载链接。
- 统一、规范化文件下载标明格式。
八、信息时间描述的不规范性
8.1、问题描述
- 参考文档时间描述的不规范性,什么是最新?没有标出文档更新的时间,用户无法与之前查看的历史版本作出对比。
8.2、造成的问题
- 由于没有标出文档的更新时间,用户无法得知什么是最新,无法与之前所查看的历史内容作出对比。
- 命名的严重不规范化。
8.3、改进建议
- 对于参考文档标出出台时间或者文档更新时间。便于用户与之前查看的历史版本作出对比。
总结
本文简单罗列了华为开发者联盟基础文档中可能存在的部分问题,仅代表个人见解,如有不足请多多指正。希望华为开发者社区越来越好,携手广大开发者共同为中国开源做贡献。后续