文章目錄
- 前言
- 一、文檔中心的外鏈跳轉問題
- 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、改進建議
- 對于參考文檔標出出臺時間或者文檔更新時間。便于用戶與之前查看的歷史版本作出對比。
總結
本文簡單羅列了華為開發者聯盟基礎文檔中可能存在的部分問題,僅代表個人見解,如有不足請多多指正。希望華為開發者社區越來越好,攜手廣大開發者共同為中國開源做貢獻。后續