Auto-sync: 2026-04-28 00:02

wiki/concepts/AGENTS.md.md

@@ -1,52 +1,40 @@
----
-title: "AGENTS.md"
-type: concept
-tags: [opencode, openclaw, project-context, agent]
-sources: [如何在ubuntu上安装opencode并配置vibe-kanban, 万字讲透openclaw-workspace深度解析-2026-03-21]
-last_updated: 2026-03-21
----
-
-## Definition
-
-**AGENTS.md** 是 AI Agent 框架中定义 Agent **工作说明书**的核心文件。存在两种语境：
-
-1. **OpenCode 语境**（自动生成）：位于项目根目录，由 `/init` 命令自动分析项目结构生成，包含项目结构、编码规范、约定俗成等上下文信息，帮助 AI 理解项目的整体背景。
-
-2. **OpenClaw 语境**（手动配置）：位于 `~/.openclaw/workspace/`，是用户手动编写的岗位说明书，定义 Agent 的职责、边界、多 Agent 协作流程。
-
-## OpenCode: 自动生成
-
-运行 `/init` 命令后，OpenCode 会自动分析项目结构并生成 `AGENTS.md`：
-
-```bash
-cd /path/to/project
-opencode
-/init
-```
-
-最佳实践：
-- **纳入版本控制**：OpenCode 官方建议将 AGENTS.md 提交到 Git，以获得一致的跨团队体验
-- **持续维护**：随着项目演进，定期更新 AGENTS.md 以反映最新的架构决策
-- **具体示例**：提供代码示例和模式说明，帮助 AI 生成符合项目风格的代码
-
-## OpenClaw: 手动配置
-
-在 OpenClaw 中，AGENTS.md 回答的是：
-- 这个 Agent 叫什么，主要职责是什么？
-- 遇到什么类型的任务该用什么方式处理？
-- 有哪些事情是绝对不该做的？
-- 当用户说某类话时，该优先走哪套流程？
-- 在多 Agent 场景里，该怎么协调其他 Agent？
-
-**经验法则**：300-500 字的 AGENTS.md，比 2000 字的更有效。边界比能力描述更重要——LLM 默认会"发挥创意"，需要约束。
-
-**场景触发优于通用指令**：与其写"始终保持专业语气"，不如写"当用户问技术问题时，使用专业准确的措辞；当用户随意聊天时，语气可以轻松一些"。
-
-## Related Concepts
-
-- [[OpenCode]] — OpenCode 语境下生成和使用 AGENTS.md 的核心工具
-- [[OpenClaw]] — OpenClaw 语境下 AGENTS.md 所属的框架
-- [[SOUL.md]] — Agent 性格档案，与 AGENTS.md 分工明确
-- [[Agent Specialization]] — AGENTS.md 定义多 Agent 协作的核心机制
-- [[Plan Mode]] — 利用 AGENTS.md 提供充足上下文以生成精准方案
-- [[Vibe Coding]] — AI 辅助编程的工作流理念
+---
+title: "AGENTS.md"
+type: concept
+tags: [opencode, ai, project-context, documentation]
+sources: [如何在ubuntu上安装opencode并配置vibe-kanban]
+last_updated: 2026-04-27
+---
+
+## Overview
+
+**AGENTS.md** 是 OpenCode 等 AI 编程代理为项目自动生成的角色定义文件，包含项目结构、编码规范和最佳实践，帮助 AI 理解项目上下文，生成更准确、更符合团队风格的代码。
+
+## Purpose
+
+当运行 `opencode /init` 时，OpenCode 会分析项目结构并自动生成 `AGENTS.md` 文件。该文件记录：
+- 项目目录结构
+- 编码规范和约定
+- 使用的技术栈
+- 项目的特殊要求或约束
+
+## Best Practice
+
+OpenCode 官方建议：**将项目的 `AGENTS.md` 文件提交到 Git 版本控制**。这样每次协作（clone/checkout）时 AI 都能获取最新的项目上下文，保证不同开发者、不同会话中 AI 行为的一致性。
+
+## File Location
+
+- 项目根目录：`<project>/AGENTS.md`
+- 会被 OpenCode 自动加载，无需手动指定
+
+## Related Concepts
+
+- [[Vibe Coding]] — AGENTS.md 是 Vibe Coding 工作流中上下文固定的关键机制
+- [[Plan Mode]] — Plan Mode 依赖 AGENTS.md 提供项目上下文
+- [[Build Mode]] — Build Mode 依赖 AGENTS.md 保持编码风格一致
+- [[OpenCode]] — AGENTS.md 由 OpenCode 的 `/init` 命令自动生成
+
+## Aliases
+- agents.md
+- agents file
+- 项目角色定义文件