Claude Code 文档导航
欢迎使用 Claude Code 文档系统！本目录包含五个互补的文档，帮助你从零开始高效使用 Claude Code 进行开发。
📚 文档体系
五个文档的关系
bash
┌─────────────────────────────────────────────────────────────────┐
│ Claude Code 文档体系 │
├─────────────────────────────────────────────────────────────────┤
│ │
│ 快速上手教程 ───> 实战指南 ───> 进阶技巧 │
│ (2小时入门) (场景实战) (高级技能) │
│ │
│ ▲ ▲ ▲ │
│ │ │ │ │
│ └──────────────┼─────────────┘ │
│ │ │
│ ▼ │
│ ClaudeCode.md (模板库) │
│ 34个模板 │
│ │
│ ▲ │
│ │ │
│ CLAUDE.md (项目规范) │
│ │
└─────────────────────────────────────────────────────────────────┘📖 文档说明
0. 快速上手教程.md - 2小时入门（新手必读）
定位: 零基础友好，2小时快速掌握核心技能
内容结构:
第一部分: 核心理念（15分钟）
- 为什么需要结构化提示词
- 三段式工作流详解
第二部分: 必备技能（30分钟）
- 5个核心语法（@引用、修饰符等）
- 三段式工作流实操
第三部分: 实战演练（60分钟）
- 场景1: 简单逻辑增加
- 场景2: Bug修复
- 场景3: 方案选择
第四部分: 快速避坑（10分钟）
第五部分: 下一步指引（5分钟）
适用对象:
- ✅ 从未使用过 Claude Code
- ✅ 想要快速上手
- ✅ 需要系统化学习
学习路径:
bash
第1步: 阅读核心理念（理解"为什么"）
第2步: 学习必备技能（掌握"怎么做"）
第3步: 完成实战演练（动手练习）
第4步: 查看避坑指南（避免错误）
第5步: 进入实战指南（实际应用）1. ClaudeCode.md - 提示词模板库
定位: 通用模板库，提供原子能力
内容结构:
- 11 个开发阶段
- 34 个提示词模板
- 96 个实战示例
- 涵盖分析、设计、实施、优化全流程
适用场景:
- ✅ 单次操作 (查询代码、修改变量名等)
- ✅ 需要查找特定语法
- ✅ 学习提示词编写技巧
- ✅ 快速查询模板格式
如何使用:
- 按阶段查找需要的模板
- 复制模板并替换占位符
- 根据项目实际情况调整
示例:
bash
需要: 理解某个函数的逻辑
查找: 阶段 1 - 分析阶段 → 模板 1.1 代码逻辑分析
使用: 复制模板，替换文件路径和行号2. 实战指南.md - 场景驱动手册
定位: 场景手册，提供完整解决方案
内容结构:
第一部分: 文档项目专属场景 (5 个)
- 添加单个函数文档
- 批量生成函数文档
- 文档格式标准化
- 导航配置优化
- VitePress 主题定制
第二部分: 通用工作流程 (6 个)
- 新功能开发
- 代码重构
- Bug 修复
- 配置变更
- 内容迁移
- 性能优化
第三部分: 最佳实践
第四部分: 常见问题
第五部分: 附录
适用场景:
- ✅ 为文档站点添加新内容
- ✅ 执行多步骤的文档处理流程
- ✅ 需要完整工作流程指导
- ✅ 批量文档生成和优化
如何使用:
- 根据你的需求找到对应场景
- 按照场景中的轮次逐步执行
- 每个场景都提供了完整的提示词模板
示例:
bash
需要: 为 PostgreSQL 添加 10 个函数文档
查找: 第一部分 → 场景 2: 批量生成函数文档
流程: 按 6 轮流程执行 (格式分析 → 数据准备 → 分批生成 → 配置更新)3. 进阶技巧.md - 高级技能（进阶必读）
定位: 深入掌握高级技巧，提升复杂项目协作效率
前置条件:
- ✅ 已学习快速上手教程
- ✅ 已使用实战指南完成 2-3 个场景
- ✅ 有 1-2 周实践经验
内容结构:
第一部分: 复杂场景处理（45分钟）
- 流程组合技巧（串行/并行）
- 长任务拆分策略
- 多模块协作
第二部分: 团队协作技巧（30分钟）
- 建立 CLAUDE.md 规范
- 多人协作最佳实践
- 代码风格统一
第三部分: 上下文管理策略（30分钟）
- 何时清空上下文
- 清空后快速恢复
- 避免上下文污染
第四部分: 性能优化实践（30分钟）
- 识别性能瓶颈
- 优化 N+1 查询
- 缓存和异步处理
第五部分: 案例研究（45分钟）
- 大型功能开发
- 紧急 Bug 修复
- 系统性重构
适用场景:
- ✅ 处理复杂的多模块任务
- ✅ 团队协作开发
- ✅ 大型项目管理
- ✅ 性能优化需求
学习建议:
bash
何时学习: 使用 1-2 周后，遇到复杂场景时
学习方式: 按需学习，遇到问题查阅对应章节
实践方式: 在真实项目中应用学到的技巧4. CLAUDE.md - 项目规范文档
定位: 项目知识库，供 Claude Code 实例参考
内容结构:
- 项目概览 (技术栈、目录结构)
- 常用命令
- 架构说明 (VitePress 配置、主题、插件)
- 文档格式规范
- 开发注意事项
适用场景:
- ✅ 初次打开项目时让 AI 理解项目
- ✅ 需要遵循项目特定规范
- ✅ 团队协作时统一标准
- ✅ 新 Claude Code 会话开始时引用
如何使用:
在对话开始时引用此文档:
bash
@CLAUDE.md 请阅读项目规范
然后执行: [具体任务]🚀 快速开始
新手学习路径（推荐）
bash
┌─────────────────────────────────────────┐
│ 第1天: 快速上手（2小时） │
│ 📖 阅读: 快速上手教程.md │
│ 🎯 完成: 3个实战练习 │
│ ✅ 掌握: 三段式工作流 │
└─────────────────────────────────────────┘
│
▼
┌─────────────────────────────────────────┐
│ 第2-7天: 实战应用（每天30分钟） │
│ 📖 使用: 实战指南.md │
│ 🎯 完成: 2-3个真实任务 │
│ ✅ 熟悉: 常用场景流程 │
└─────────────────────────────────────────┘
│
▼
┌─────────────────────────────────────────┐
│ 第2-4周: 进阶提升（按需学习） │
│ 📖 阅读: 进阶技巧.md │
│ 🎯 应用: 复杂项目场景 │
│ ✅ 掌握: 高级协作技巧 │
└─────────────────────────────────────────┘场景 1: 第一次使用 Claude Code（从快速上手教程开始）
推荐步骤:
先阅读 快速上手教程.md（2小时）
- 理解核心理念
- 学习必备技能
- 完成3个实战演练
然后查看项目规范:
bash@CLAUDE.md 请阅读并理解项目规范 我是第一次使用这个项目，请简要介绍： 1. 项目的主要功能 2. 目录结构 3. 我可以做什么开始第一个真实任务（使用实战指南）
场景 1B: 快速实战（如果你已有基础）
步骤:
打开 Claude Code
发送以下消息:
bash@CLAUDE.md 请阅读并理解项目规范 我是第一次使用这个项目，请简要介绍： 1. 项目的主要功能 2. 目录结构 3. 我可以做什么根据 AI 的介绍，决定下一步操作
场景 2: 我想添加一个新的函数文档
步骤:
- 查看 实战指南.md
- 找到 "场景 1: 添加单个函数文档"
- 按照 3 轮流程执行
快速启动:
bash
@docs/AI/实战指南.md#场景-1-添加单个函数文档
我需要为 PostgreSQL 函数 [函数名] 添加文档
请按照场景 1 的流程帮我完成场景 3: 我想批量生成多个文档
步骤:
- 准备函数信息 (名称、描述、语法、示例)
- 查看 实战指南.md
- 找到 "场景 2: 批量生成函数文档"
- 按照 6 轮流程执行
场景 4: 我想修改导航或侧边栏
步骤:
- 查看 实战指南.md
- 找到 "场景 4: 导航和侧边栏配置优化"
- 按照 4 轮流程执行
场景 5: 我需要单个提示词模板
步骤:
- 查看 ClaudeCode.md
- 根据开发阶段查找模板
- 复制并使用模板
示例:
bash
需要理解代码 → 查找 "阶段 1: 分析阶段" → 模板 1.1
需要讨论方案 → 查找 "阶段 2: 设计阶段" → 模板 2.1
需要开始编码 → 查找 "阶段 3: 实施阶段" → 模板 3.1📋 使用决策树
根据你的需求，快速找到应该使用哪个文档:
bash
开始
│
├─ 是否第一次使用 Claude Code？
│ ├─ 是 → 使用 快速上手教程.md（2小时必读）
│ └─ 否 → 继续
│
├─ 是否需要完整的多步骤流程？
│ ├─ 是 → 使用 实战指南.md
│ └─ 否 → 继续
│
├─ 是否遇到复杂场景（多模块协作/性能优化）？
│ ├─ 是 → 使用 进阶技巧.md
│ └─ 否 → 继续
│
├─ 是否是单次简单操作？
│ ├─ 是 → 使用 ClaudeCode.md
│ └─ 否 → 继续
│
├─ 是否需要了解项目规范？
│ ├─ 是 → 使用 CLAUDE.md
│ └─ 否 → 继续
│
└─ 不确定？
→ 先查看本 README.md
→ 根据场景描述选择文档🎯 常见问题
Q1: 这三个文档有什么区别？
回答:
- ClaudeCode.md: 模板库，提供单个操作的提示词模板
- 实战指南.md: 场景手册，提供多步骤的完整工作流程
- CLAUDE.md: 项目规范，供 AI 理解项目上下文
Q2: 我应该从哪个文档开始？
回答:
- 新手: 先看本 README.md，然后阅读实战指南的 "快速开始"
- 查找模板: 直接看 ClaudeCode.md 的目录
- 执行任务: 根据任务类型选择实战指南中的场景
Q3: 可以组合使用吗？
回答: 可以！推荐组合使用方式:
bash
# 开始任务时引用项目规范
@CLAUDE.md
# 执行复杂任务时使用实战指南
@docs/AI/实战指南.md#场景-1
# 需要特定模板时查询 ClaudeCode.md
参考 @docs/AI/ClaudeCode.md 中的模板 1.1Q4: 如何更新和维护这些文档？
回答:
- 发现模板不够用 → 在 ClaudeCode.md 中添加新模板
- 发现新的使用场景 → 在实战指南.md 中添加新场景
- 项目规范变更 → 更新 CLAUDE.md
📚 文档版本
| 文档 | 版本 | 最后更新 | 说明 |
|---|---|---|---|
| 快速上手教程.md | v1.0 | 2025-10-22 | 2小时入门，5个部分 |
| ClaudeCode.md | v1.0 | 2025-10-22 | 34 个模板，96 个示例 |
| 实战指南.md | v1.0 | 2025-10-22 | 11 个完整场景流程 |
| 进阶技巧.md | v1.0 | 2025-10-22 | 5个高级主题，3小时 |
| CLAUDE.md | v1.0 | 2025-10-13 | VitePress 项目规范 |
| README.md (本文档) | v1.1 | 2025-10-22 | 5文档导航和学习路径 |
🔗 相关链接
💡 最佳实践建议
- 新手入门: 从快速上手教程开始，2小时掌握核心技能
- 开始新会话时: 先引用
@CLAUDE.md让 AI 理解项目 - 执行复杂任务时: 使用实战指南中的完整流程
- 单次简单操作时: 直接使用 ClaudeCode.md 中的模板
- 遇到复杂场景时: 查阅进阶技巧寻找解决方案
- 团队协作时: 统一遵循 CLAUDE.md 中的规范
- 文档维护时: 及时更新文档，保持一致性
📝 反馈和改进
如果你在使用过程中有任何建议或发现问题，请:
- 记录具体的使用场景
- 说明遇到的问题或不足
- 提出改进建议
- 更新相应文档
祝使用愉快！
如有疑问，请先查看本导航文档，然后根据需求选择对应的文档进行深入阅读。