Experience現代化代理的提示指南 prompting-guide
Experience Modernization Agent可使用自然語言處理請求。 對於每種型別的任務(例如移轉頁面或設定區塊樣式),都會遵循稱為技能的內建工作流程。 它會從您的要求中選擇技能,因此您不需要命名。 某些技能屬於選用功能,代理程式會在要求需要時,提供這些功能來開啟您的專案。
本指南會依您的使用順序提供範例提示:計畫、移轉、檢查、縮放以及持續開發。 請依照移轉生產網站的完整移轉程式。 區段、預設內容、區塊和變體在設定內容結構形狀中皆有說明。 將提示中的範例URL和路徑替換為您自己的路徑。
指定代理程式內容 context
代理程式知道Edge Delivery Services並讀取您的專案程式碼。 在您指出之前,它不知道您的業務、您的品牌規則或您的網站使用的其他系統,而具有正確內容的每個請求都會儲存一輪更正。 共用工作需求:
- 目標及檢查方式:您想要什麼、誰想要什麼,以及完成的結果是什麼樣子。
- 範圍和目的地:來源頁面或設計、目的地路徑、儲存內容的位置、存放庫和分支、不可變更的專案,以及代理程式是否可以上傳、推播或發佈。
- 需求:規格以及品牌與協助工具規則。
- 範例:看起來正確的頁面、熒幕擷圖、Figma連結或範例API回應。
- 檔案:公用檔案的連結,代理程式會在網頁上閱讀這些檔案,或在檔案本身需要登入時閱讀這些檔案。 附加檔案不接受PDF檔案,因此請從這些檔案複製相關文字。 請參閱提示輸入。
- 已作出決定:在
AGENTS.md中保留已同意的慣例及其列出的檔案,這樣您就不會在每個要求中重複這些慣例。 請參閱專案指示與記憶體。
分享任務需求(而非您擁有的一切),並遵循貴組織關於AI工具中可能包含哪些內容的原則。
也請提出問題:關於Edge Delivery Services概念、您的專案程式碼,以及方法之間的取捨。 當您不確定如何做某件事時,請先詢問在Edge Delivery Services中如何完成,再要求代理程式完成,或切換至 計畫 模式以檢閱其方法。 要求代理程式列出其問題和假設:回答這些問題比更正結果快。
不讓聊天室取得秘密 secrets
聊天不是安全的秘密場所。 您輸入或附加的所有內容都會傳送到AI模型並保留在對話中。 代理程式會將其視為任何其他文字:它可以將值複製到專案的檔案中,例如指令碼或設定檔案。 推送該檔案後,值會保留在存放庫的歷史記錄中,而存放庫中的所有內容都會傳送至您網站訪客的瀏覽器。 您在 設定 中輸入的認證從未連絡代理程式。 請參閱認證。
將它們排除在聊天之外、排除在附件之外,以及排除在專案檔案之外:
- 密碼,包括測試帳戶的密碼以及您自己的Adobe ID或Git帳戶的密碼
- API金鑰、存取權杖和個人存取權杖
- 私密金鑰和憑證
- 連線字串、工作階段Cookie以及自行授與存取權的連結,例如已簽署的URL
.env個檔案的內容和其他包含密碼的設定- 真實客戶或員工的個人資料;請改用虛構的範例資料
- 貴組織政策禁止用於AI工具的任何其他內容
在附加熒幕擷圖、記錄、匯出的檔案或錯誤訊息之前,請先檢查這些內容,然後遮罩它們。
認證前往何處 credential-settings
當任務需要金鑰時,請勿貼上金鑰以完成任務。 在表格顯示處輸入它,並為代理程式指定沙箱或測試端點,而不是生產端點。
如果您已共用機密 secret-shared
- 立即撤銷或取代核發該機密的服務。 清除聊天不會收回已傳送的內容,而代理程式工作階段的記錄會保留該內容,直到您重設工作區為止。
- 檢查 變更 檢視中是否有包含密碼的檔案,並在您推送之前捨棄這些變更。
- 如果已推送包含密碼的檔案,則取代密碼即為修正方法。 稍後的認可會將其從檔案中移除,但不會從存放庫的歷史記錄中移除。
- 根據您組織的原則要求,通知您的安全性團隊。
會指示代理程式不要使用您貼在聊天中的秘密,並指示您取代該秘密。 不要依賴它:當它回答時,秘密已經達到AI模型。
調整結果 general-tips
發生錯誤時(例如區塊上的背景顏色錯誤),請要求代理程式修正此問題,而非重新開始。 為來源URL命名、輸出路徑、您看到的內容以及您預期的內容。 如需更多提示,請參閱提示提示。
網站建立和移轉提示 site-migration
移轉遵循下列順序: 編目網站、移轉每個範本的範例頁面、移轉設計、檢查含有批註的結果,然後匯入範本的其他頁面。 頁首、導覽和頁尾為整個網站設定一次。 如需完整程式,請參閱移轉生產網站。
使用網站目錄進行計畫 site-catalog
在移轉網站之前,請使用這些提示來檢視網站規模、範本和區塊。 若要開始目錄,請參閱使用網站目錄規劃移轉。
- 「在
https://www.example.com上尋找範本」 - 「
https://www.example.com上有多少頁面型別?」
擷取Source頁面 scraping-webpages
頁面移轉會從擷取來源頁面開始。 移轉頁面之前,請先自行要求分析頁面。
- 「擷取
https://www.example.com/products以進行分析。」 - 「在行動裝置和案頭寬度從
https://www.example.com/product擷取內容和中繼資料。」
須知事項:
- 代理程式會在瀏覽器中載入頁面並捲動,以便載入延遲載入的影像。 關於它擷取的內容,包括指令碼插入或CSS隱藏的內容以及無法擷取的內容,請參閱限制。
- 它會擷取頁面的標題、說明、開放圖表標籤、JSON-LD結構化資料和標準URL。
- 它會儲存熒幕擷圖和影像的復本,並將連結和影像參照標準化。 對照來源檢查影像,包括回應式影像、背景和SVG影像,並檢查每個連結是否仍指向應該指向的位置。
- 要求特定的熒幕寬度,例如行動或案頭。 每個額外寬度都需要較長的時間。
移轉頁面 migrate-a-site
使用這些提示從現有網站匯入頁面。 若要逐步匯入第一個頁面,請參閱逐步匯入頁面,或針對Experience Manager製作中儲存的內容,請參閱連線網站並匯入頁面。
- 「移轉這些頁面:
https://www.example.com/products/hiking,https://www.example.com/products/climbing。 重複使用現有的區塊。 請勿上傳、推送或發佈。」
須知事項:
- 代理程式會決定每個頁面的區段、預設內容、區塊和變體,並在專案建立新區塊之前重複使用專案的區塊。 在第一個頁面上檢查此結構:作者會編輯它,而大量匯入會重複它。 請參閱設定內容結構形狀。
- 內容和設計是獨立的步驟。 內容匯入後,代理程式建議開始設計移轉:選取它,或要求來源樣式。 如需新的設計,請參閱移轉期間重新設定樣式。
- 頁面匯入會忽略頁首、導覽和頁尾。 請參閱設定頁首、導覽及頁尾。
- 每次移轉都會寫入頁面範本的匯入指令碼,大量匯入會在範本的其他頁面上執行。
- 如需影像的去向,包括從Dynamic Media提供的影像,請參閱影像和檔案。
移轉設計 design-migration
使用這些提示在匯入的內容上重新建立來源網站的設計。
- 「從
https://www.example.com移轉設計」 - “擷取設計權杖”
- 「打造主圖區塊的風格」
- 「設定所有區塊的樣式」
須知事項:
- 代理程式會先設定整個網站的樣式。 它會將設計權杖(例如字型、顏色、間距和標題大小)作為CSS自訂屬性寫入
styles/brand.css。styles/styles.css會匯入該檔案,並設定預設內容的樣式:標題、段落、按鈕、連結和區段背景。 - 然後,它會從代號平行設定區塊的樣式(每個區塊位於
blocks/{name}/{name}.css中)。 因此,區塊樣式會先使用全網站的樣式。 - 如果專案已有
brand.css或其他權杖檔案,請要求代理程式使用這些檔案,而不是從來源擷取第二個集合。 - 說明要求是全域還是單一區塊,以及是否應該忠實於來源或遵循新設計。 在桌上型電腦和行動裝置寬度的真實頁面上檢視結果。
設計接近的程度 design-fidelity
代理程式會重新建立來源設計:它會擷取設計權杖、為每個區塊設定樣式,然後將每個區塊與來源進行比較,並修正發現的差異。 請參閱評論網站。 結果在第一次通過時接近原始值,而您會透過提示來更正剩餘的值。
無法保證有相同的副本。 字型、影像壓縮和瀏覽器演算可能與來源稍有不同,「相同」對不同專案的含義也不同:一個團隊測量畫素的間距,另一個團隊檢查品牌是否讀取相同。 來源也有其自身的缺陷,例如相同範本的兩個頁面之間的間距不同,重新建立它們對新網站很少會有幫助。
目標為預期設計:
- 說明每個與頁面、熒幕寬度以及應該變更的專案的其餘差異,並在預覽中檢查結果。 複雜的設計可能需要幾個回合。
- 修正全域樣式或區塊CSS中重複出現的差異,讓此修正套用至每個頁面。
- 縮放之前,請同意網站登出者認為夠接近的專案,並在範例頁面上檢視。
從Figma建立區塊 figma-block-migration
使用這些提示從Figma元件建置一個區塊。 從圖形設計工作涵蓋存取權杖、您需要的座位,以及為何一次使用一個元件。
- 從這個Figma元件建立區塊:
{Figma link}。 重複使用我們的設計代號。」 - 「從Figma檔案
{fileKey}移轉pricing-card元件。」
須知事項:
- 在Figma中,選取元件並複製其連結,讓連結包含識別元件的
node-id:https://www.figma.com/design/{fileKey}?node-id={nodeId}。 或提供檔案金鑰和元件名稱。 - 代理程式會先讀取元件的結構(讓大型Figma檔案保持在可管理狀態),然後讀取其設計細節。 在寫入任何CSS之前,它會新增顏色、印刷樣式和間距作為設計權杖至
styles/styles.css,並使用區塊特定的權杖。 它會將元件對應至專案中最近的區塊,並建立變體、從權杖寫入變體的CSS、將影像和圖示儲存在主控台工作區中,以及建立範例內容。 然後預覽區塊並與Figma設計進行比較。
使用來自Figma的區塊重新設計 figma-redesign-migration
當網站在移轉期間取得新設計時,請使用這些提示:Figma提供設計和區塊,而即時網站提供內容。 如需程式與要比較的內容,請參閱移轉期間重新設定樣式。
- 「從這些Figma元件建立區塊集合:
{Figma link}」 - 「移轉這些頁面,並將其內容對應至從Figma建立的區塊:
https://www.example.com/adventures,https://www.example.com/magazine」
僅當Figma中的區塊無法代表來源內容時,才詢問新變體。
從Figma建立新頁面 figma-new-page-from-figma
當來源網站上不存在頁面,且圖形框架或頁面應該變成新頁面時,請使用此提示。
- 「將此Figma頁面移轉至位於
/events的新頁面:{Figma link}」
須知事項:
- 選取一個框架或頁面,而不是整個檔案,並將它組織成清晰的頁面區段。
- 代理程式會將每個區段對應至現有區塊、預設內容或新變體。 文字和影像來自菲格瑪。
- 圖形框架顯示某個功能的外觀,而不是其資料來自何處或其行為。 針對搜尋、電腦、個人化或商店位置,Figma移轉會建立版面。 然後要求代理程式將行為建置為動態區塊,並提供API或資料來源。
設定頁首、導覽和頁尾 navigation-setup
在頁首、導覽和頁尾使用這些提示,包括頁尾影像。 頁面匯入會將它們排除在外,因為每個頁面共用一個頁首和一個頁尾。
- 「從
https://www.example.com設定導覽」 - 「從
https://www.example.com移轉頁尾」 - 修正導覽功能表
使用AEM樣板頁首和頁尾的專案須知:
- 頁首從內容根載入
nav頁面,而頁尾載入footer頁面,除非頁面的nav或footer中繼資料命名另一個頁面。 在以檔案為基礎的專案中,代理程式會將導覽寫入主控台工作區中做為nav.md。 - 導覽頁面有三個區段,以
---分隔:品牌、標誌和首頁的連結;主要功能表;以及工具,例如登入或訂閱的連結。 - 包含巢狀清單的功能表專案會變成下拉式清單。
- 僅在其段落中的粗體或斜體連結會變成按鈕,就像在其他頁面上一樣,品牌連結除外:標題會移除其按鈕樣式。 請參閱範例:沒有原子區塊的彈性Teaser。
- 如果專案已變更
header.js或footer.js,請要求代理程式先檢查它們。 - 若為Experience Manager製作,請確認導覽頁面的儲存位置及其使用的模型。
評論網站 site-critique
設計移轉後,使用這些提示來比較每個移轉的範本與來源,並一次修正差異。
- 「評論網站」
- 「驗證整個移轉網站的所有區塊」
須知事項:
- 結構差異(例如缺少標題或連結,或列數錯誤)會在匯入指令碼中修正,然後頁面會再次匯入。 樣式差異(例如顏色、間距和印刷樣式)會在CSS中固定。
- 代理程式會逐層運作:全域樣式、區段、區塊內容,然後封鎖CSS。 它會在每個圖層之後再次檢查結果。
- 當同一問題出現在使用相同區塊的多個頁面上時,代理程式會針對所有頁面修正區塊一次。
- 若沒有
brand.css,代理程式只會修正結構。 - 此評論會比較頁面的外觀。 另外檢查作者是否可以編輯這些專案、互動是否有效,以及它們是否可以存取;請參閱限制。 檢閱評論回報的涵蓋範圍和未解決的問題。
評論頁面 page-critique
使用這些提示來檢查一個已移轉的頁面,例如在網站評論後。
- 「評論關於頁面」
- 「對
https://www.example.com/about驗證移轉的頁面/about」
代理程式需要來源URL和移轉的路徑,而且它與網站評論使用相同的圖層。 檢查預覽中剩餘的差異。
評論區塊 block-critique
使用這些提示可在設計移轉後檢查一個區塊。
- 「批判英雄區塊」
- 「驗證自訂卡片區塊」
區塊必須來自頁面移轉。 代理程式會修正它,如同在網站評論中一樣。
大量匯入頁面 bulk-import
在範本的範例頁面移轉並檢查後,使用這些提示來匯入範本的其他頁面。
- 「在這些頁面上執行大量匯入:
https://www.example.com/blog/first-post、https://www.example.com/blog/second-post。」 - 「大量匯入所有產品頁面。」
須知事項:
封鎖開發提示 block-development-capabilities
在移轉期間或任何專案中,這些提示會建立和變更區塊。 如需程式和檢查,請參閱建立、更新和重構區塊。
設計內容模型 content-modeling
使用這些提示來設計作者填入區塊的表格。 內容導向開發會在建立區塊時執行此步驟;單獨要求它來比較選項。
- 「為表揚區塊設計內容模型」
- 「這個輪播的最佳內容模式為何?」
須知事項:
-
四個圖樣涵蓋大部分的區塊:
- 獨立:單一資料表中一個不同的元素,例如主圖或引號。
- 集合:重複專案,例如卡片或輪播投影片,每個專案有一列。
- 組態:其內容來自API或資料來源的區塊,例如部落格清單或搜尋結果,其索引鍵值列控制其顯示內容。 請參閱建置動態區塊。
- 自動封鎖:作者寫入為區段或預設內容,且程式碼變成區塊的內容,例如索引標籤或YouTube內嵌的內容。
-
將每個表格自然保留為幾個儲存格和群組相關元素,讓作者可以填入。 適用於作者:區塊程式碼可讀取任何表格結構。
-
樣式差異偏好使用區塊變體,而非設定儲存格。
-
接受彈性輸入,遵循Postel的定律:主圖區塊無論其內容是在一個儲存格、兩個儲存格中還是在不同的列中,都應運作。
-
針對Experience Manager製作,區塊還需要通用編輯器的模型。 請參閱建立區塊。
尋找參考區塊 reference-blocks
使用這些提示來尋找現有的實施,以從中開始。
- 「尋找類似定價表的區塊」
- 「哪些區塊可供證明使用?」
- 「索引標籤實作的搜尋區塊當事方」
須知事項:
開發區塊 block-development
使用這些提示來建立區塊或變更現有區塊。
- 「建立證明區塊」
- 「將視訊背景變體新增至主圖區塊」
須知事項:
搜尋檔案 searching-documentation
使用這些提示尋找Edge Delivery Services功能和實施的指南。
- 「如何在Edge Delivery Services中延遲載入影像?」
- 「在檔案中搜尋章節中繼資料」
代理程式在aem.live上搜尋檔案和部落格。 使用特定關鍵字(例如「區塊裝飾」、「sidekick外掛程式」或「中繼資料」),而非一般關鍵字(例如「網站」或「如何建置」)。 若要從程式碼開始,請改為要求參考區塊。 檢查它對您專案的程式碼找到的內容,以及儲存其內容的位置。
測試變更 testing
在開啟提取請求之前,使用這些提示來測試變更。
- 「測試新卡片區塊」
- 「在我開啟提取請求之前執行測試」
代理程式會在其值超過維護成本時寫入測試。 它會保留邏輯密集程式碼(例如公用程式、資料處理和API整合)的單元測試,因為這些測試會快速擷取重複使用程式碼中的回歸。 瀏覽器檢查涵蓋區塊如何變更頁面、其互動及外觀。 有關提取要求前要檢查的專案,請參閱驗證並傳遞。
對問題進行偵錯 debugging
當區塊、影像、樣式或預覽無法如預期運作時,請使用這些提示。 如需更深入的檢查,代理程式可以開啟Edge Delivery Services疑難排解選用功能。
- 「偵錯為什麼影像顯示為:error左右」
- 「修正無法呈現的主圖區塊」
- 「為什麼我的變更沒有顯示在預覽中?」
須知事項:
-
代理程式會依序檢查原始程式檔、轉譯的頁面、區塊代碼和瀏覽器主控台。 它使用主控台的預覽,因此您不需要執行本機伺服器。
-
常見原因:
-
請保留失敗的URL和錯誤詳細資料,並在您修正原因後重試受影響最小的範圍。 在您覆寫或重設工作之前,請參閱釋放、復原和移交。
在Edge Delivery Services以外工作 beyond-eds
代理程式的技能和指示主要放在Edge Delivery Services:移轉頁面、建置和樣式區塊,以及遵循專案的慣例。 代理程式本身是通用編碼代理,因此不限於此代理。 它可以將您的網站連線到商務平台、行銷自動化平台、搜尋或地圖服務,或您自己的API、調整您的團隊使用React建立的應用程式,或編寫您的團隊部署的伺服器端服務的程式碼。 與其他程式碼代理程式整合的適合用途也在這裡:檔案優先、計畫碼之前、測試的小步驟,以及撰寫的決定。
若要瞭解來源網站與哪些內容整合,請要求代理列出範例頁面載入的第三方服務,例如Analytics、Tag Management、同意、地圖、視訊、聊天、搜尋和表單。 然後與您的團隊一起決定每個專案在新網站上如何運作。
對於其他系統,代理程式沒有技能,只有一般知識,而且可能過時。 系統自己的檔案使工作可靠,因此一起工作:
- 請它先閱讀檔案。 將系統開發人員檔案的連結提供給代理程式,或附加該連結。 在撰寫任何程式碼之前,請先要求說明整合的運作方式、必須在伺服器上執行什麼作業,以及涉及哪些秘密。 在此階段更正其理解。
- 要求Edge Delivery Services方式。 詢問整合是否屬於區塊、Widget或專案的指令碼,以及它如何讓頁面保持快速。 代理程式會提出方法並詢問需要瞭解的事項。
- 提供系統所需的內容:端點、欄位名稱、範例要求與回應,以及沙箱或測試帳戶。 如需代理程式運作時需要的金鑰,請參閱認證移至。
- 以小步驟建置。 針對非生產端點測試預覽中的每個步驟。
- 記錄結果。 要求代理程式在專案的指示檔案中寫入所選的方法和檔案連結,以便下一個對話從這裡開始。
例如:
閱讀
https://developer.example.com/store-locator上商店定位服務的開發人員檔案,特別是其搜尋API。 說明我們的網站如何根據Edge Delivery Services實務顯示/stores上最近的商店:哪些專案會在瀏覽器中執行、哪些專案需要伺服器,以及涉及哪些秘密。 列出您的問題。 不要變更任何檔案。
將範例服務、URL和路徑取代為您自己的路徑。
設定其他系統、部署伺服器端服務及儲存其秘密,由您的團隊及該系統管理員共同管理。 如需整合模式,請參閱連線服務與應用程式。
範例:Slack (進階)中的更新 slack-updates
設定中的認證、專案技能以及AGENTS.md中的某一行可以將代理程式連線到您團隊已經使用的工具。 組建代理程式的團隊中,有一位開發人員將其設定為每次在Slack完成時發佈摘要(其中包含已變更的內容),並在其中閱讀其回覆以作為進一步指示。 他可以在不保持主控台開啟的情況下,追蹤並操控一項長期工作。
代理程式會將其在頻道中讀取的內容視為指示,就像聊天一樣。 保持管道私密,僅讓您和機器人在其中,以便只有您可以指示代理程式。 其張貼的摘要會離開主控台供Slack使用,因此請依照您組織的原則處理可能前往該處的內容。 當您不再使用 設定 中的專案時,請將其移除。 相同的模式適用於其他具有HTTP API (接受固定標題)的工具。