讓你的文件從靜態展示到一鍵部署可操作驗證

阿里云云栖号發表於2024-04-26

使用者在根據文件進行操作時,會出現根據文件內容搭建環境困難、程式碼除錯失敗、功能無法使用的情況,主要是由於文件中有年久失修、沒人維護、無法跑通的程式碼,給使用者快速上手帶來很多的挑戰。

為了解決文件中的這些使用者體驗問題,透過函式計算的能力讓阿里雲的文件從靜態展示升級為動態可操作驗證,使用者在文件中單擊一鍵部署可快速完成程式碼的部署及測試。這一改變已在函式計算的活動沙龍中得到使用者的認可,你也快來體驗一下吧~~

使用者問題及痛點

阿里雲的產品作為技術驅動型解決方案,使用者對文件中提供的程式碼示例有較高的依賴。透過分析,發現使用者在使用文件時有以下問題。

文件中提供的程式碼錯誤,使用者無法直接使用

使用如下的程式碼示例,在測試時一直報錯,導致使用者無法直接使用。文件中的程式碼示例由於長時間未更新和缺乏維護,已經變得過時,這直接影響使用者使用文件時的體驗。

程式碼示例: image 報錯資訊: image

文件中只提供程式碼片段,使用者除錯門檻高

文件中只提供程式碼片段,缺乏完整的專案結構和環境配置指南,使用者需要自己搭建專案和設定執行環境,才能使用文件中介紹的功能,這無疑增加了使用者實際操作的難度,甚至會嚇退很多新手使用者。

image

文件中沒有提供程式碼,使用者無法參考文件使用該功能

例如:函式計算的配置OSS檔案系統文件中,只提供給使用者如何配置OSS掛載,卻沒有提供如何訪問OSS掛載檔案相應的程式碼示例,這直接導致使用者想使用該功能時參考該文件無法獲取想要的資訊。

原文件內容: image 使用者期待的文件內容: image

解決方案:提供動態可操作驗證的文件

函式計算是一種Serverless架構模式,專注於事件驅動的函式程式設計,提供端到端的解決方案。使用者使用函式計算,不需要採購與管理伺服器等基礎設施,只需編寫並上傳程式碼或映象。同時函式計算支援多種程式語言,函式建立完成後可以快速除錯驗證。

如果文件中的程式碼能夠部署在函式計算平臺,那麼使用者可以在文件中直接操作驗證程式碼提供的功能,會直接提升使用者使用文件程式碼的體驗。

實現方案

整個解決方案的流程示意圖如下所示。

image

  1. 透過Serverless Devs工具開發併發布完整程式碼對應的應用模板。

  2. 在文件中配置一鍵部署,將程式碼片段與應用模板關聯,併發布文件。

  3. 使用者在文件中單擊一鍵部署後,根據應用名稱在函式計算部署應用,並可以直接測試程式碼功能。

文件效果

使用函式計算部署通義千問大模型實現AI對話文件為例,介紹文件動態可操作的效果。

使用者可以在文件中使用一鍵部署的入口

  • 文件最上方。

image

  • 支援一鍵部署的程式碼片段前面,重點提醒使用者可點選。支援一鍵部署的程式碼codeblock右上角。

image

單擊一鍵部署後

單擊一鍵部署後,會根據配置的應用模板將程式碼需要開通的服務、角色、配置的引數在皮膚中呈現,使用者需開通及配置。

image

部署並檢視應用

  1. 應用部署成功後,可以檢視應用的基本情況。

  2. 單擊操作列的測試,即可進入函式計算提供的測試頁面。

  3. 在測試頁面,已預設將測試引數填入,單擊測試函式,即可根據引數進行函式呼叫。

  4. 最終會返回函式呼叫返回結果。

image

使用者反饋

在2023年12月的函式計算活動沙龍中,有70多名使用者體驗了該文件的一鍵部署能力。在2024年1月的活動沙龍中,有2000多名使用者參與任務的體驗,其中有500使用者完成。使用者反饋從文件直接部署降低了體驗該功能的門檻

image

總結

文件中增加一鍵部署後有以下優勢:

  • 使用者文件使用體驗提升

原來使用者在文件中看到的是文字說明及程式碼片段,要自己搭建環境,構造完整的專案程式碼使用該功能,耗時不僅長且容易出錯,對於新手使用者不友好。

現在使用者可以直接單擊一鍵部署即可以快速體驗該功能,不僅提高操作效率,還可以降低使用過程中的錯誤率。

  • 快速驗證程式碼的正確性

原來文件中提供程式碼,需要使用者單獨構建專案環境驗證保證程式碼正確性,整體成本高。

現在文件中的程式碼已關聯完整的可執行程式碼,可以快速部署驗證程式碼正確性,降低程式碼驗證的成本。

  • 快速獲取完整程式碼

原來文件中的程式碼大部分是研發提供的程式碼片段,並未提供完整的程式碼,導致程式碼片段和可完整執行的程式碼割裂,使用者無法快速從文件獲取完整的程式碼。

現在文件中的程式碼統一在GitHub倉庫維護,文件中呈現程式碼片段,每次變更可找到原始碼修改,使用者可以透過文件操作獲取到完整程式碼。

最後

好的文件應當超越文字的界限,成為知識傳遞和技能培養的橋樑。阿里雲函式計算讓我們朝著這一目標邁出了重要一步。我們將文件從傳統的靜態頁面升級為一個動態的、互動性強的工具,使用者可以透過一鍵部署直接在函式計算平臺驗證文件內容。這種轉變較大地提升了文件的可操作性和實際應用價值,讓使用者不只是閱讀和理解概念,還能透過實際操作使用該能力。

我們誠邀所有使用者來體驗函式計算文件從靜態到動態的轉變,希望透過你們的參與和反饋,不斷最佳化文件,助力每位使用者在學習和使用文件的過程中實現最大化的收益。

如果您希望體驗文件的一鍵部署能力,可以訪問下面文件連結。

  • 使用函式計算部署通義千問大模型實現AI對話

  • 使用函式計算實現自動解壓上傳到OSS的ZIP檔案

  • 請求處理程式(Handler)

  • 日誌

  • 錯誤處理

  • 快速建立函式
    更多內容關注 Serverless 微信公眾號(ID:serverlessdevs),彙集 Serverless 技術最全內容,定期舉辦 Serverless 活動、直播,使用者最佳實踐。

相關文章