AI助手导航

欢迎来到 AI 助手指南目录！本目录包含了为不同 AI 编程助手准备的项目协作文档。

📚 文档列表

AGENTS.md - 通用指南 ⭐

适用对象: 所有 AI 编程助手（Gemini、Claude、Cursor、GitHub Copilot 等）

内容概览:

• 项目完整结构说明
• 统一的文档编写规范
• 配置文件详细说明
• VuePress 特殊语法
• 开发工作流程
• 常见问题解决方案

HOW-TO-USE.md - 配置生效指南 🔥

适用对象: 所有开发者

内容概览:

• 各 AI 工具的具体配置方法
• 配置生效的验证方法
• 文档内容调整建议
• 常见问题解答
• 快速配置指南

GEMINI.md - Gemini 专用指南

适用对象: Google Gemini AI 助手

内容概览:

• Gemini User Rules/Memory 配置方法
• 配置验证步骤（4 种方法）
• Gemini 特有优势（上下文理解、持久化记忆、多模态）
• 使用技巧和常见问题
• 完整配置示例

CLAUDE.md - Claude 专用指南

适用对象: Anthropic Claude AI 助手

内容概览:

• Claude Desktop 和 Web 版配置方法
• 项目文件引用技巧（@ 符号）
• 配置验证步骤
• Claude 特有优势（多文件上下文、长文本处理）
• 使用技巧和配置模板

🎯 使用建议

对于 AI 助手

1. 首次协作: 先阅读 AGENTS.md 了解项目整体情况
2. 深入了解: 根据自己的类型查看对应的专用指南
3. 遵循规范: 严格按照文档中的规范进行协作

对于开发者

1. 配置 AI 工具: 将对应的文档路径配置到你使用的 AI 工具中
2. 保持更新: 项目结构变化时及时更新这些文档
3. 反馈改进: 发现问题或有改进建议请及时更新文档

🔧 配置示例

Cursor / VS Code

在项目根目录创建 .cursorrules 文件：

请参考 docs/ai/agents/AGENTS.md 中的项目规范进行协作。

Claude Desktop

在对话中引用文档：

请先阅读 @docs/ai/agents/CLAUDE.md 了解项目规范。

GitHub Copilot

在 .github/copilot-instructions.md 中添加：

# 项目规范

请遵循 docs/ai/agents/AGENTS.md 中定义的编码规范。

📝 文档维护

更新频率

• 项目结构变化: 立即更新
• 规范调整: 及时同步
• 新增功能: 补充说明
• 定期审查: 每月检查一次

维护原则

1. 保持同步: 三个文档的核心规范应保持一致
2. 突出特点: 专用指南可以针对特定 AI 的特性进行优化
3. 简洁明了: 避免冗长的描述，使用列表和表格
4. 实用为主: 提供可操作的指导，而非理论说明

🚀 快速链接

• 返回 AI 导航
• AI 编程助手
• 开源编程工具
• 项目首页

---

创建日期: 2026-02-03
维护团队: OmniStackHub