生成项目文档 project-documentation
Experience Modernization Agent为您的网站上工作的人员(作者、开发人员和管理员)编写指南。 它根据项目的代码构建它们,并在您允许的情况下根据站点的配置构建它们,并将它们作为PDF交付给接管项目的团队。
指南的内容包括 project-handovers
- 项目演练:项目的设置和结构方式以及遵循的约定。
- 代码组织:块、模块和组件的组织方式以及它们彼此的关系。
- 基于角色的指南:每个作者、开发人员和管理员的指南。
这些指南描述了代理可以读取的内容:控制台工作区中的代码,以及管理员API中的站点配置(授予使用Adobe凭据的权限)。 它无法读取的系统(例如集成或CDN配置)不包括在内。
先决条件 prerequisites
创建文档 creating-documentation
-
询问代理
Create documentation for this project。 说出指南的适用对象、作者编辑内容(Experience Workspace或通用编辑器)的位置,以及您对代码不显示的项目的了解。 -
如果代理要求,请提供项目的组织名称。
-
当代理询问要创建哪个文档时,选择 全部 或您需要的指南。
-
代理将参考线放置在控制台工作区中。 选择一个可查看其说明,然后选择其链接以下载PDF。
已创建
在共享指南之前,请检查其设置步骤、内容位置、命令、创作步骤以及针对项目的说明限制。 对于基于文档的项目,您还可以将PDF与其他内容一起上传到Experience Workspace。
保留人员和代理的上下文 portable-handoff
PDF可以在某个时间点描述项目。 要保留下一个人员或对话所需的上下文,请在项目的Git存储库中保留一个简短的Markdown切换文件。 控制台不会生成此文件;您和代理将写入此文件。
包含:
对于Experience Manager创作,还会记录模型和配置更改、站点和DAM目标、包导入结果以及您在通用编辑器中检查的内容。 对于基于文档的内容,请记录文档的存储位置以及有关转移或覆盖这些文档的任何决策。
引用来自AGENTS.md的文件,以便代理在任务需要它时找到它。 请参阅使用AGENTS.md作为入口点。 绝不要包含令牌、密码或其他密钥。
设置文件的日期,并在代码、模型、内容或部署发生更改时对其进行更新。 生成的PDF和更早的对话会过时;两者都不会显示现在实时的内容。
疑难解答 troubleshooting
当生成失败时,修复以下原因,然后再次生成受影响的指南并进行检查。
“访问被拒绝”、“未授权”或“配置API错误” unauthorized
代理无法通过管理员API读取站点配置。 检查您是否具有此站点的管理员访问权限,以及先决条件中的凭据设置是否已启用。 如果您不需要配置,请改为请求仅代码指南。
“未找到项目” not-found
项目存储库未在控制台工作区中签出。 按照连接您的站点中的说明连接它。