工作手册

什么是工作手册

工作手册(AGENTS.md)是一份纯文本文件,用于向 AI 助手传达你的偏好、规范和项目背景。当你在对话中与 AI 交互时,工作手册的内容会被自动注入到系统提示词中,让 AI 在每次对话开始前就了解你的需求。

工作手册分为两级: - 全局工作手册:对所有工作区生效,适合放置通用偏好(如语言、代码风格) - 项目工作手册:仅对当前工作区生效,适合放置项目特定的规范

工作原理

每次发起对话时,系统会按以下顺序组装提示词:

  1. 系统提示词模板(内置)
  2. 环境信息(工作目录、日期、模型等)
  3. 工作手册内容(全局 + 项目)

如果两级工作手册都存在,内容会依次拼接,项目级可以覆盖或补充全局级的规则。工作手册内容为空或文件不存在时,该级别会被自动跳过。

最佳实践

  • 保持简洁:工作手册会占用上下文窗口,避免放入过长的内容
  • 使用 Markdown 格式:标题、列表、代码块等结构化内容更易被 AI 理解
  • 明确优先级:将最重要的规则放在最前面
  • 全局 vs 项目:通用偏好(响应语言、代码风格)放全局,项目架构和命名约定放项目级
  • 定期更新:随着项目演进,及时调整工作手册内容

示例内容:

# 项目规范
- 使用中文回复
- 代码注释使用英文
- 遵循 Swift API Design Guidelines
- 提交信息使用中文