本文档总结了 Augment Code 官方博客 中关于使用 Augment Agent 的最佳实践。

目录

简介

AI 编码代理(如 Augment Agent)的工作方式与人类相似。最有效的使用方法是将其视为与一位聪明但经验较少的工程师合作。近期 AI 的进步与人类工作方式有许多相似之处:

Augment Agent 适合做什么?

Augment Agent 在以下方面表现出色:

随着开发人员发现新的应用场景,这个列表还在不断扩展。

如何向 Agent 分配任务?

1. 使用详细的提示

不好的例子:"将 [SettingsWebviewPanel](https://zhida.zhihu.com/search?content_id=256109949&content_type=Article&match_order=1&q=SettingsWebviewPanel&zhida_source=entity) 类改为使用事件"

好的例子

目前,我们通过导入 `SettingsWebviewPanel` 类直接触发 `SettingsWebviewPanel.statusUpdate()`。 审核人员建议切换到 VSCode 事件来触发 `statusUpdate()`, 以减少组件之间的紧密耦合。 让我们通过以下步骤实现: 1. 创建一个新的 VSCode 事件 2. 在 `SettingsWebviewPanel` 构造函数中添加事件处理程序 3. 触发这个事件而不是直接调用 `statusUpdate()`

2. 提供全面的背景信息

3. 将复杂任务分解为更小的部分

不好的例子:"阅读任务单 BC-986,实现设置菜单,编写测试并更新文档"

好的例子:先要求阅读任务单 BC-986,然后实现设置菜单,再编写测试并更新文档

4. 对于复杂任务,先与 Agent 讨论和完善计划

不好的例子:"在设置菜单中公开时区选择"

好的例子:"我需要在设置菜单中公开时区选择。首先提出一个计划,在我批准之前不要跳到实现阶段"

5. 利用 Agent 对测试结果进行迭代的能力

不好的例子:手动运行测试并将输出复制粘贴给 Agent

好的例子:"为 'TextGenerator' 类实现测试,并运行它们以确保它们正常工作"

6. 尝试在不熟悉的任务上使用 Agent

好的例子:"我需要实现这个新的过滤算法。请探索代码并提出一些可行的实现方案"

7. 提供积极反馈

好的例子:"很好,差不多对了!现在让我们处理这个边缘情况..."

当 Agent 没有按照预期工作时怎么办?

如果 Agent 偏离了轨道,您有两个选择:

  1. 开始一个新的 Agent 会话(如果完全偏离)
  2. 在同一会话中引导它回到正确的方向(如果只是稍微偏离)

其他提示:

如果不信任 Agent 怎么办?

Agent 运行时应该做什么?

用户与 Agent 的互动通常会经历三个技能水平:

  1. 初学者:密切关注 Agent,经常中断以纠正
  2. 中级:在偶尔检查进度的同时进行多任务处理
  3. 高级:为不同的任务设置多个 Agent 会话,定期检查

如何审查 Agent 编写的代码?