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、改進建議

• 對于參考文檔标出出台時間或者文檔更新時間。便于使用者與之前檢視的曆史版本作出對比。

總結

本文簡單羅列了華為開發者聯盟基礎文檔中可能存在的部分問題，僅代表個人見解，如有不足請多多指正。希望華為開發者社群越來越好，攜手廣大開發者共同為中國開源做貢獻。