Claude AI 助手配置指南

本文档专门说明如何配置 Anthropic Claude AI 助手以遵循本项目规范。

📋 前置阅读

在配置 Claude 之前，请先阅读：

• AGENTS.md - 了解完整的项目规范
• HOW-TO-USE.md - 了解配置原理和验证方法

🔧 Claude 配置方法

方式 A: Claude Desktop（推荐）

Claude Desktop 支持项目级配置，配置一次即可在所有对话中生效。

步骤 1: 创建项目配置文件

在项目根目录创建 .claude/project.json：

{
  "name": "OmniStackHub",
  "description": "VuePress 2.x 技术知识库项目",
  "instructions": "请严格遵循 docs/ai/agents/AGENTS.md 中定义的项目规范进行协作"
}

步骤 2: 在对话中引用文档

使用 @ 符号引用项目文档：

@docs/ai/agents/AGENTS.md

Claude 会自动读取文档内容并遵循其中的规范。

步骤 3: 引用其他项目文件

可以引用任何项目文件：

@docs/.vuepress/config.js
@docs/ai/code/antigravity.md

方式 B: Claude Web 版

Web 版不支持项目配置，需要在每次对话时手动提供规范。

方法 1: 直接粘贴规范

我正在开发一个 VuePress 项目，请遵循以下规范：

项目类型: VuePress 2.x 知识库
技术栈: Vue 3 + Vite + vuepress-theme-hope

文档规范:
1. 必须包含 frontmatter (title, date, category, tag)
2. 正文从 H2 开始
3. 标题前后保留空行
4. 代码块必须指定语言

配置规范:
1. CommonJS 格式
2. 2 空格缩进
3. 单引号字符串
4. 更新 sidebar 时同步更新 navbar

现在请帮我...

方法 2: 上传规范文件

1. 点击上传按钮
2. 选择 docs/ai/agents/AGENTS.md
3. Claude 会读取文件内容

✅ 验证配置是否生效

方法 1: 询问项目信息

这个项目使用什么技术栈？

期望回答: VuePress 2.x、Vue 3、Vite、vuepress-theme-hope

方法 2: 测试文档创建

帮我在 docs/ai/ 目录下创建一个新文档

检查 Claude 是否:

• ✅ 添加了正确的 frontmatter
• ✅ 从 H2 开始使用标题
• ✅ 标题前后有空行
• ✅ 代码块指定了语言

方法 3: 测试配置修改

帮我在侧边栏添加一个新分类

检查 Claude 是否:

• ✅ 同时更新了 navbar 和 sidebar
• ✅ 使用了正确的格式
• ✅ 添加了注释说明

🎯 Claude 特有优势

1. 项目文件引用

Claude Desktop 可以直接引用项目文件，无需复制粘贴：

@docs/.vuepress/config.js 请帮我添加新的侧边栏配置

2. 多文件上下文

可以同时引用多个文件：

@docs/ai/agents/AGENTS.md
@docs/.vuepress/config.js
请根据规范更新配置文件

3. 长文本处理

Claude 擅长处理长文档，可以一次性分析整个项目结构。

💡 使用技巧

技巧 1: 使用项目模板

创建常用的对话模板：

@docs/ai/agents/AGENTS.md
我需要创建一个新的文档分类，请帮我：
1. 创建目录结构
2. 创建 README.md
3. 更新 config.js 的 navbar 和 sidebar

技巧 2: 批量文件操作

@docs/ai/agents/AGENTS.md
请检查以下文件是否符合项目规范：
@docs/ai/code/antigravity.md
@docs/ai/code/cursor.md

技巧 3: 代码审查

@docs/ai/agents/AGENTS.md
@docs/.vuepress/config.js
请审查配置文件，指出不符合规范的地方

技巧 4: 持续对话

在同一对话中，Claude 会记住之前引用的规范：

# 第一条消息
@docs/ai/agents/AGENTS.md
帮我创建一个新文档

# 后续消息（无需再次引用）
现在帮我更新侧边栏配置

🚨 常见问题

Q1: Claude 没有遵循规范怎么办？

解决方法:

1. Desktop 版: 检查 .claude/project.json 是否存在
2. Web 版: 在对话开始时重新提供规范
3. 明确提醒："请严格遵循 AGENTS.md 中的规范"
4. 引用具体规范："请注意，标题前后必须有空行"

Q2: 如何在新对话中快速应用规范？

Desktop 版:

@docs/ai/agents/AGENTS.md

Web 版:

创建一个规范摘要文本文件，每次对话时上传。

Q3: Claude 的建议与其他 AI 工具不一致？

解决方法:

1. 确保引用的是最新版本的规范文档
2. 在规范中使用更明确的描述
3. 提供具体的代码示例
4. 在对话中明确指出差异并要求遵循项目规范

Q4: 如何更新已配置的规范？

步骤:

1. 修改 docs/ai/agents/AGENTS.md
2. Desktop 版: 在新对话中重新引用文档
3. Web 版: 重新上传或粘贴更新后的规范

📚 相关资源

• AGENTS.md - 完整项目规范
• HOW-TO-USE.md - 配置和验证指南
• README.md - 文档导航

🔄 配置示例

Desktop 版完整配置

文件: .claude/project.json

{
  "name": "OmniStackHub",
  "description": "基于 VuePress 2.x 的全栈技术知识库",
  "instructions": "请严格遵循以下规范：\n\n1. 文档规范：所有 Markdown 文件必须包含 frontmatter，从 H2 开始，标题前后有空行，代码块指定语言\n2. 配置规范：使用 CommonJS 格式，2 空格缩进，单引号字符串\n3. 重要：更新 sidebar 时必须同步更新 navbar\n\n详细规范请参考：docs/ai/agents/AGENTS.md"
}

Web 版快速配置模板

# OmniStackHub 项目规范

## 项目信息
- 类型: VuePress 2.x 知识库
- 技术: Vue 3 + Vite + vuepress-theme-hope

## 核心规范
1. Markdown 文档必须包含 frontmatter
2. 正文从 H2 开始，标题前后有空行
3. 代码块必须指定语言类型
4. 配置文件使用 CommonJS 格式
5. 2 空格缩进，单引号字符串
6. 更新 sidebar 时同步更新 navbar

## 当前任务
[在这里描述你的需求]

---

创建日期: 2026-02-03
最后更新: 2026-02-04
维护团队: OmniStackHub