產生專案檔案 project-documentation
Experience現代化代理程式會為網站上工作的人員(作者、開發人員和管理員)撰寫指南。 它會從專案的程式碼建置這些程式,並在您許可下從網站的設定建置這些程式,然後以可提供給接管專案團隊的PDF格式傳送。
指南涵蓋的內容 project-handovers
- 專案逐步說明:專案的設定和結構方式,以及遵循的慣例。
- 程式碼組織:區塊、模組和元件的組織方式以及彼此的關係。
- 角色型指南:作者、開發人員和管理員各自的指南。
這些指南說明代理程式可讀取的內容:主控台工作區中的程式碼,以及管理API的網站設定(具有使用Adobe憑證的許可權)。 無法讀取的系統(例如整合或CDN設定)則不在涵蓋範圍內。
先決條件 prerequisites
建立檔案 creating-documentation
-
詢問代理程式
Create documentation for this project。 說明指南的適用對象、作者編輯內容(Experience Workspace或通用編輯器)的位置,以及您對計畫碼未顯示的專案所知道的內容。 -
如果代理程式要求,請提供專案的組織名稱。
-
當代理程式詢問要建立哪些檔案時,請選取 全部 或您需要的指南。
-
代理程式會將參考線放置在您的主控台工作區中。 選取其中一個以檢視其說明,然後選取其連結以下載PDF。
在您共用指南之前,請檢查其設定步驟、內容位置、命令、製作步驟,以及針對專案所述的限制。 對於檔案型專案,您也可以在Experience Workspace中上傳PDF以及其他內容。
保留人員與代理程式的內容 portable-handoff
PDF會同時說明專案。 若要保留下一個人員或交談所需的內容,請在專案的Git存放庫中保留簡短的Markdown交接檔案。 主控台不會產生這個檔案;您和代理程式會寫入它。
包含:
若為Experience Manager製作,也記錄模型和設定變更、網站和DAM目的地、套件匯入結果,以及您在Universal Editor中檢查的專案。 對於檔案型內容,請記錄檔案的儲存位置以及有關轉移或覆寫檔案的任何決策。
參考AGENTS.md中的檔案,讓代理程式在任務需要它時找到它。 請參閱使用AGENTS.md作為進入點。 絕對不要包含權杖、密碼或其他秘密。
設定檔案日期,並在程式碼、模型、內容或部署變更時進行更新。 產生的PDF及之前的交談會過時;兩者都不會顯示現在的內容。
疑難排解 troubleshooting
當產生失敗時,請修正以下原因,然後再次產生受影響的參考並加以檢查。
「存取遭拒」、「未獲授權」或「設定API錯誤」 unauthorized
代理程式無法透過管理API讀取網站設定。 檢查您是否有該網站的管理員存取權,以及先決條件中的認證設定是否已啟用。 如果您不需要設定,請改為要求僅限程式碼指南。
「找不到專案」 not-found
您主控台工作區中的專案存放庫並未出庫。 依照連線您的網站中的說明連線。