Agent 和 Chat 的指令指南（Guidelines）

你可以用自然语言撰写一些自定义的「指令指南」，来告诉 Augment 你的偏好、最佳实践、编码风格，以及你使用的技术栈，从而让 Agent 和 Chat 的回复更贴合你的需求。

关于指南（Guidelines）

Agent 和 Chat 的指令指南是一种用自然语言写的说明，它能让 Augment 更加准确地理解你的编码习惯和技术偏好。它适用于那些无法通过 linter 或编译器配置的偏好，比如你希望使用的包版本、代码风格或实现方式。

你可以为特定工作区（workspace）设置指令指南，也可以设置全局指南（适用于所有聊天）。但目前，指南不适用于自动补全（Completions）、Instructions 或 Next Edit。

用户级别指南（User Guidelines）

添加用户指南

如何添加用户指南

你可以在 Chat 输入框中通过点击上下文菜单或者输入 @ 来添加指令指南。添加后，这些指南会应用到所有打开的编辑器中的 Chat。

步骤如下：

  1. 选择 User Guidelines
  2. 输入你的指令指南（下面有写建议写法）
  3. 点击 Save

如何更新或移除用户指南

点击 User Guidelines 的「上下文标签」可以修改或删除现有指南。你在任意编辑器中做出的更改，会同步到所有打开的编辑器中。

工作区级别指南（Workspace Guidelines）

你还可以在代码仓库的根目录下添加一个 .augment-guidelines 文件，来为整个项目设定一致的聊天指令。

这个文件建议加入版本控制（git），这样项目中所有成员在使用 Augment 时都会遵循相同的指南。

编写好指南的小技巧

  • 用列表的方式写更清晰
  • 使用简单、明确的语言表达你的意图
  • 如果你强制要求「简短回复」或「只返回代码」，可能会降低回答的质量

用户指南的例子（User guideline examples）

  • 需要额外解释（例：对于 TypeScript 代码，请多解释代码在做什么）
  • 指定回答语言（例：请用西班牙语回答问题）

工作区指南的例子（Workspace guideline examples）

  • 指定偏好的库（例：使用 pytest 而不是 unittest）
  • 指定框架用法（例：NextJS 项目请使用 App Router 和 server components）
  • 避免某些反模式（例：禁止使用某个已废弃的内部模块）
  • 命名规范（例：函数名必须以动词开头）

注意事项

指南最多支持 2000 个字符，别写太长。