API 文件是參考資料;開發者簡報則是入門指南。您的文件列出了每個端點、參數和回應程式碼,但開發者首先需要的是理解其概念:API 的功能、身份驗證機制以及如何進行首次呼叫。透過 Gamma,您可以連接文件來源或貼上內容,讓 AI 代理在幾分鐘內將繁雜的參考資料轉化為清晰、可視化的開發者演示,其中包含概念、流程和範例呼叫。
挑戰在於順序。文件的組織方式是為了方便查找、按字母順序排列端點、列出詳盡的參數,而簡報則必須以循序漸進的方式進行講解。你不可能透過從上到下閱讀參考文件來引導開發人員入門。 Gamma 的代理會閱讀你的文檔,詢問整合人員是誰以及他們需要完成什麼,然後將內容重新組織成一個能夠幫助開發人員成功完成首次呼叫的簡報。
優秀的開發者示範能將參考文件轉化為易於理解的內容:
先解釋 API 的功能以及它解決的問題
提前完成身份驗證,因為沒有它一切都無法運作。
在介紹端點之前,先展示核心概念和資源模型。
示範首次通話流程,包括具體的請求和回覆。
突顯開發人員實際上會使用最多的關鍵端點
指向完整文件,了解其他所有內容
最好的開發者演示能讓觀眾產生「我明白如何使用這個」的感受,而不是「我已經看過每個介面」。
連接文件所在的工具,例如 Confluence、GitHub 文件倉庫或 Notion,Gamma 即可直接匯入內容,無需複製貼上。喜歡直接在文件中操作?只需貼上參考文件或 Markdown 程式碼即可。無論哪種方式,Gamma 都能讀取並理解其 API 文件。連接資料來源只需不到一分鐘,即使 API 發生變更,也能快速更新簡報。
Gamma 的代理會確認整合者的身分和目標,閱讀文檔,並將其整理成一個流程,其中包含:概述、身分驗證、概念、首次呼叫、關鍵介面和資源。參考資料最終會形成一個幫助使用者逐步理解的敘述。
Gamma 會自動將您的範例請求轉換為易讀的程式碼區塊,將您的身份驗證和請求流程轉換為圖表,並將您的資源模型轉換為清晰的視覺化影像。開發人員無需面對冗長的參考文本,即可輕鬆理解概念。
連接您的文件來源或準備好要貼上的參考內容。概覽、身份驗證和一些關鍵端點為代理提供了最全面的功能。
開啟 gamma.app,從提示框開始。連接你的文件或貼上內容,然後提出你的需求,例如:「將此 API 文件轉換為面向集成我們 API 的工程師的開發者入門演示文稿,內容涵蓋身份驗證、核心概念和首次調用。」向代理提供一兩個簡短的答案,它就會開始工作。
Gamma提出了一個概要。典型的開發者演示流程如下:
API 的功能以及何時使用
身份驗證和取得憑證
核心概念與資源模型
您的首次請求和回复
關鍵端點和常用工作流程
錯誤、限制和最佳實踐
完整文件和資源
根據受眾群體重新排序、新增或刪除章節。需要先取得授權資訊的合作夥伴?那就把這部分內容提早。
Gamma 可產生完整且格式規範的開發者簡報,其中包含您的程式碼區塊、流程圖,並確保整體風格一致。對於合作夥伴或產品發布簡報,Max 模式則使用功能最強大的模型,進一步提升簡報的精美度。
佈局已預先構建,因此每個概念都能精準呈現。如果您需要精確放置程式碼區塊或圖表,請切換到自由編輯模式並進行精確定位。想要描述更改內容?使用 AI 編輯功能,選擇任意元素並告訴 Gamma 要執行什麼操作,例如「以圖表形式顯示授權流程」或「突出顯示必需參數」。將每個標題精簡到核心要點。
您可以進行即時演示,分享可供開發者隨時訪問的互動式網頁鏈接,或匯出為 PowerPoint、PDF 或 Google Slides 格式。您的程式碼、圖表和格式都將保留,因此開發者可以獲得他們喜歡的任何格式的資料。
Gamma 與直接引用文件的對比
格式:文件的組織方式便於尋找;簡報需要有條理的講解順序。
節奏:參考資料堆積如山;Gamma 則能精準地找出開發者最需要的內容。
視覺效果:文件以文字為主;Gamma 將流程和概念轉化為圖表。
實話實說: 把你的 API 文件當作完整的參考資料,它們本來就是用來做這個的。當你在給開發者進行現場培訓時,讓 Gamma 將文件轉換成教學演示文稿,並引導他們參考完整的參考資料以獲取詳細資訊。
Gamma 與 PowerPoint 的比較
來源:PowerPoint 初始狀態為空白;Gamma 直接讀取您的文件或連接的來源檔案。
更新:當 API 發生變更時,PowerPoint 需要手動操作;而在 Gamma 中,您可以快速從原始檔案重新產生。
設計:PowerPoint 的品質取決於您;Gamma 值保持一致。
實話實說: PowerPoint 讓您可以完全掌控客製化的簡報。而 Gamma 可以更快地將文件轉換為入職培訓演示文稿,並且您可以隨時匯出回 PowerPoint。
以思考模型為先導。 開發人員需要先了解 API 的結構,然後再了解端點。
儘早完成身份驗證。 在使用者完成身份驗證之前,其他一切都無法運行,所以不要把它藏得太深。
展示一個真實的首次呼叫。 具體的請求和回應比參數表更能說明問題。
不要列出所有接口。 重點突出開發者最常用的幾個接口,並提供其他接口的連結。
保留完整的參考資料。 引導讀者查閱文件以獲取詳盡的細節,而不是將其塞進正文。
是的。連結 Confluence、GitHub 文件倉庫、Notion 或任何你存放文件的地方,Gamma 就會直接匯入內容。你也可以根據需要貼上參考資料。
是的。 Gamma 會將程式碼渲染成清晰易讀的程式碼區塊。請保持範例簡潔明了,並使用 AI 編輯功能突出顯示所需的參數或關鍵行。
Gamma 可以將您描述的流程圖轉換為清晰的圖表。您可以使用自由編輯功能對其進行完善,或讓代理商簡化流程。
如果您的文件來源已連接,請讓 Gamma 刷新以顯示更新後的內容,或將其儲存為範本。文檔結構不變,只有內容會更新。
您的文件已經描述了所有接口,但它僅用於查找,而不是引導用戶上手。請關聯您的文件或貼上內容,告訴 Gamma 您的目標受眾及其目標,然後讓代理商將參考資料轉換為包含程式碼和圖表的教學簡報。這樣,您就能幫助開發人員快速完成首次成功通話。
