SRA 案例:关于华为开发者联盟基础服务文档内容的改进建议(华为开发者联盟文档深度体验官)

文章目录

  • 前言
  • 一、文档中心的外链跳转问题
    • 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、改进建议

  • 对于参考文档标出出台时间或者文档更新时间。便于用户与之前查看的历史版本作出对比。

总结

本文简单罗列了华为开发者联盟基础文档中可能存在的部分问题,仅代表个人见解,如有不足请多多指正。希望华为开发者社区越来越好,携手广大开发者共同为中国开源做贡献。

后续

在这里插入图片描述
在这里插入图片描述

本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如若转载,请注明出处:http://www.mzph.cn/news/530723.shtml

如若内容造成侵权/违法违规/事实不符,请联系多彩编程网进行投诉反馈email:809451989@qq.com,一经查实,立即删除!

相关文章

腾讯位置服务:有何优势?如何使用平台创建应用和服务调用的 Key?

文章目录前言一、腾讯位置服务的优势1.1、提供丰富的地图产品1.2、提供行业解决方案1.3、提供其他生态维度的支持1.4、海量的数据基础1.5、丰富的开发文档二、初识腾讯位置服务2.1、用户的注册与登录(附专属邀请码)2.2、开发者信息的完善三、创建服务平台…

毕业生当头一棒?忆本科四年,高校毕业生与就业单位基本要求差多少?工作还是考研?

文章目录前言一、大学本科前两年的生活1.1、庸庸碌碌、中规中矩1.2、收获了爱情二、大三的改变2.1、学会自律2.2、学会自我总结2.3、眼光要具有前瞻性三、毕业答辩3.1、个人设计答辩3.2、团队设计答辩四、南京之行4.1、铭记历史,感恩先辈4.2、加强自我认知与提升五、…

Gitee 答疑:为什么从 Gitee 平台 Pull 代码到 STS/Eclipse 后文件乱码?逐步排查

文章目录前言一、产生乱码场景1.1、错误描述1.2、解决思路二、解决方式2.1、检查 Git 平台上的源码2.2、Git 的运行原理2.3、修改 IDE 的文本编码格式2.4、重新打开目的文件问题解决2.5、仍存在问题看这里(重新拉区合并)总结前言 我们从 Gitee 平台 Pull…

flash 异常修复:QQ 的 flash 图标显示异常?QQ 秀、表情加载异常?一招解决

文章目录前言一、产生错误场景1.1、flash 图标显示异常1.2、解决思路二、安装合适版本的 Flash Player2.1、选择合适版本的 Flash Player2.2、安装 Flash Player三、重启 QQ 客户端四、flash 动画加载异常4.1、动画加载异常原因分析4.2、下载安装 flash 修复工具4.3、使用 Flas…

电脑广告多?Windows 自带恶意软件删除工具还不会使用?有必要安装杀毒软件吗?

文章目录前言一、启动恶意软件删除工具二、扫描类型的选择三、启动软件扫描四、恶意软件删除工具的说明五、对于恶意软件处理的建议总结前言 可能有些小伙伴发现,哎?为什么我的电脑弹窗广告这么多?难不成小视频看多了?电脑中毒了&…

《软件项目管理(第二版)》第 8 章——项目团队与干系人 重点部分总结

文章目录 前言一、简答题二、论述题总结前言 学习了项目的开发与发布之后,我们就可以单独对一个项目进行开发了,但是在企业中开发中,除了编码之外,还需要项目管理、团队协作开发等,这就是软件项目管理板块要学习的内容。本文是对《软件项目管理(第二版)》第 8 章——项目…

《软件项目管理(第二版)》第 7 章——项目风险管理 重点部分总结

文章目录 前言一、单选题二、填空题三、简答题四、论述题总结前言 学习了项目的开发与发布之后,我们就可以单独对一个项目进行开发了,但是在企业中开发中,除了编码之外,还需要项目管理、团队协作开发等,这就是软件项目管理板块要学习的内容。本文是对《软件项目管理(第二…

《软件项目管理(第二版)》第 6 章——项目质量管理 重点部分总结

文章目录 前言一、单选题二、判断题三、简答题总结前言 学习了项目的开发与发布之后,我们就可以单独对一个项目进行开发了,但是在企业中开发中,除了编码之外,还需要项目管理、团队协作开发等,这就是软件项目管理板块要学习的内容。本文是对《软件项目管理(第二版)》第 6…

《软件项目管理(第二版)》第 5 章——项目进度和成本管理 重点部分总结

文章目录 前言一、填空题二、简答题三、论述题总结前言 学习了项目的开发与发布之后,我们就可以单独对一个项目进行开发了,但是在企业中开发中,除了编码之外,还需要项目管理、团队协作开发等,这就是软件项目管理板块要学习的内容。本文是对《软件项目管理(第二版)》第 5…

《软件项目管理(第二版)》第 1 章——概述 重点部分总结

文章目录 前言一、填空题二、判断题三、简答题总结前言 学习了项目的开发与发布之后,我们就可以单独对一个项目进行开发了,但是在企业中开发中,除了编码之外,还需要项目管理、团队协作开发等,这就是软件项目管理板块要学习的内容。本文是对《软件项目管理(第二版)》第 1…

《软件项目管理(第二版)》第 2 章——项目准备和启动 重点部分总结

文章目录 前言一、单选题二、判断题三、简答题总结前言 学习了项目的开发与发布之后,我们就可以单独对一个项目进行开发了,但是在企业中开发中,除了编码之外,还需要项目管理、团队协作开发等,这就是软件项目管理板块要学习的内容。本文是对《软件项目管理(第二版)》第 2…

《软件项目管理(第二版)》第 3 章——项目计划 重点部分总结

文章目录 前言一、单选题二、填空题三、简答题总结前言 学习了项目的开发与发布之后,我们就可以单独对一个项目进行开发了,但是在企业中开发中,除了编码之外,还需要项目管理、团队协作开发等,这就是软件项目管理板块要学习的内容。本文是对《软件项目管理(第二版)》第 3…

《软件项目管理(第二版)》第 4 章——项目估算 重点部分总结

文章目录 前言一、单选题二、简答题总结前言 学习了项目的开发与发布之后,我们就可以单独对一个项目进行开发了,但是在企业中开发中,除了编码之外,还需要项目管理、团队协作开发等,这就是软件项目管理板块要学习的内容。本文是对《软件项目管理(第二版)》第 4 章——项目…

《软件需求分析(第二版)》第 1 章——软件需求基础知识 重点部分总结

文章目录 前言一、单选题二、填空题三、判断题四、简答题总结前言 软件需求分析就是把软件计划期间建立的软件可行性分析求精和细化,分析各种可能的解法,并且分配给各个软件元素。需求分析是软件定义阶段中的最后一步,是确定系统必须完成哪些工作,也就是对目标系统提出完整…

《软件需求分析(第二版)》第 2 章——客户眼中的需求 重点部分总结

文章目录 前言一、简答题总结前言 软件需求分析就是把软件计划期间建立的软件可行性分析求精和细化,分析各种可能的解法,并且分配给各个软件元素。需求分析是软件定义阶段中的最后一步,是确定系统必须完成哪些工作,也就是对目标系统提出完整、准确、清晰、具体的要求。本文…

《软件需求分析(第二版)》第 3 章——需求工程的推荐方法 重点部分总结

文章目录 前言一、单选题二、填空题总结前言 软件需求分析就是把软件计划期间建立的软件可行性分析求精和细化,分析各种可能的解法,并且分配给各个软件元素。需求分析是软件定义阶段中的最后一步,是确定系统必须完成哪些工作,也就是对目标系统提出完整、准确、清晰、具体的…

《软件需求分析(第二版)》第 4 章——需求分析员的职责 重点部分总结

文章目录 前言一、简答题总结前言 软件需求分析就是把软件计划期间建立的软件可行性分析求精和细化,分析各种可能的解法,并且分配给各个软件元素。需求分析是软件定义阶段中的最后一步,是确定系统必须完成哪些工作,也就是对目标系统提出完整、准确、清晰、具体的要求。本文…

《软件需求分析(第二版)》第 6 章——获取客户的需求 重点部分总结

文章目录 前言一、简答题总结前言 软件需求分析就是把软件计划期间建立的软件可行性分析求精和细化,分析各种可能的解法,并且分配给各个软件元素。需求分析是软件定义阶段中的最后一步,是确定系统必须完成哪些工作,也就是对目标系统提出完整、准确、清晰、具体的要求。本文…

《软件需求分析(第二版)》第 7 章——聆听客户的需求 重点部分总结

文章目录 前言一、简答题总结前言 软件需求分析就是把软件计划期间建立的软件可行性分析求精和细化,分析各种可能的解法,并且分配给各个软件元素。需求分析是软件定义阶段中的最后一步,是确定系统必须完成哪些工作,也就是对目标系统提出完整、准确、清晰、具体的要求。本文…

《软件需求分析(第二版)》第 10 章——编写需求文档 重点部分总结

文章目录 前言一、单选题二、简答题三、名词解释总结前言 软件需求分析就是把软件计划期间建立的软件可行性分析求精和细化,分析各种可能的解法,并且分配给各个软件元素。需求分析是软件定义阶段中的最后一步,是确定系统必须完成哪些工作,也就是对目标系统提出完整、准确、…