生成项目文档 project-documentation

Experience Modernization Agent为您的网站上工作的人员(作者、开发人员和管理员)编写指南。 它根据项目的代码构建它们,并在您允许的情况下根据站点的配置构建它们,并将它们作为PDF交付给接管项目的团队。

指南的内容包括 project-handovers

  • 项目演练:​项目的设置和结构方式以及遵循的约定。
  • 代码组织:​块、模块和组件的组织方式以及它们彼此的关系。
  • 基于角色的指南:​每个作者、开发人员和管理员的指南。

这些指南描述了代理可以读取的内容:控制台工作区中的代码,以及管理员API中的站点配置(授予使用Adobe凭据的权限)。 它无法读取的系统(例如集成或CDN配置)不包括在内。

先决条件 prerequisites

  • 您的项目将在控制台工作区中签出。
  • 项目文档是可选功能。 如果您的项目未打开该功能,代理会在您请求文档时提供将其打开功能,并要求您确认。
  • 要包含站点配置,您需要该站点的管理员访问权限,并且​允许LLM将我的Adobe凭据用于admin.hlx.page、Document Authoring以及托管在GitHub外部的存储库,这些凭据已在设置中启用。 该权限涵盖管理员API和Experience Workspace,而不是创作实例的Java内容存储库(JCR)。 没有它,代理仅记录代码。 要求它列出它无法检查的配置和内容,以便读者了解指南漏掉了哪些内容。

创建文档 creating-documentation

  1. 询问代理Create documentation for this project。 说出指南的适用对象、作者编辑内容(Experience Workspace或通用编辑器)的位置,以及您对代码不显示的项目的了解。

  2. 如果代理要求,请提供项目的组织名称。

  3. 当代理询问要创建哪个文档时,选择​ 全部 ​或您需要的指南。

    创建文档

  4. 代理将参考线放置在控制台工作区中。 选择一个可查看其说明,然后选择其链接以下载PDF。

    已创建 文档

在共享指南之前,请检查其设置步骤、内容位置、命令、创作步骤以及针对项目的说明限制。 对于基于文档的项目,您还可以将PDF与其他内容一起上传到Experience Workspace。

管理员指南

保留人员和代理的上下文 portable-handoff

PDF可以在某个时间点描述项目。 要保留下一个人员或对话所需的上下文,请在项目的Git存储库中保留一个简短的Markdown切换文件。 控制台不会生成此文件;您和代理将写入此文件。

包含:

什么
有用的详细信息
项目标识
存储库和分支、源URL、存储内容的位置、作者使用的编辑器(Experience Workspace或通用编辑器)以及预览和实时URL。
决策
商定的范围、设计参考及其版本、源内容如何映射到块、项目惯例以及哪些内容不能更改。
选中的示例
Source和输出路径、作者可编辑的块示例、模型和变体指令,以及作者是否可以编辑、保存和重新打开它们。
状态
仅存在于控制台工作区中的内容、上传的内容、推送的代码以及预览或发布的代码。
质量和差距
检查已运行及其结果、覆盖范围、失败或跳过的页面、未完成的集成以及签名者。
下一步和恢复
其余的任务,它需要的权限和依赖项,如何恢复代码,以及如何恢复内容和资产,这是一个独立的过程。

对于Experience Manager创作,还会记录模型和配置更改、站点和DAM目标、包导入结果以及您在通用编辑器中检查的内容。 对于基于文档的内容,请记录文档的存储位置以及有关转移或覆盖这些文档的任何决策。

引用来自AGENTS.md的文件,以便代理在任务需要它时找到它。 请参阅使用AGENTS.md作为入口点。 绝不要包含令牌、密码或其他密钥。

设置文件的日期,并在代码、模型、内容或部署发生更改时对其进行更新。 生成的PDF和更早的对话会过时;两者都不会显示现在实时的内容。

疑难解答 troubleshooting

当生成失败时,修复以下原因,然后再次生成受影响的指南并进行检查。

“访问被拒绝”、“未授权”或“配置API错误” unauthorized

代理无法通过管理员API读取站点配置。 检查您是否具有此站点的管理员访问权限,以及先决条件中的凭据设置是否已启用。 如果您不需要配置,请改为请求仅代码指南。

“未找到项目” not-found

项目存储库未在控制台工作区中签出。 按照连接您的站点中的说明连接它。

recommendation-more-help
experience-manager-cloud-service-help-main-toc