Skip to content

00.1 如何使用本手册

一份关于「怎么读这份手册」的元说明。

读完你能做什么:知道该跳过哪些章节、代码块里的约定是什么、以及如何让 Claude 本身成为这份手册的讲解员。


一、这不是一本从头读到尾的书

本手册总计 13 个模块、50+ 篇文档。没有任何人需要全部读完。

正确的用法有三种:

用法场景入口
路径式你是新手,想系统建立能力00.2 四条学习路径
查询式你卡在某个具体问题上12.3 故障排查手册 或直接 grep
索引式你想找某个参数/命令12.1 完整命令速查卡

二、全局约定

2.1 UI 元素的双语写法

本手册中所有界面元素统一写作 [English] (中文)

  • [New Chat] (新建对话)
  • [Artifacts] (工件)
  • [Projects] (项目)
  • [Connectors] (连接器)
  • [Extended Thinking] (扩展思考)

为什么保留英文原文? 因为 Claude 客户端的中文本地化文案会随版本变化,而英文标识符相对稳定。当你在界面上找不到「新建对话」时,找 New Chat 一定能找到。同时,绝大多数官方文档、社区讨论、报错信息都是英文的,双语映射让你的检索能力翻倍。

2.2 代码块的语言标记

每个代码块都带语言标记,含义如下:

标记含义你该怎么处理
bash终端命令可直接复制到 shell 执行
json配置文件内容复制进对应的 settings.json / .mcp.json
yamlfrontmatter 或 CI 配置注意缩进,YAML 对缩进敏感
markdownMarkdown 文件内容(如 SKILL.md整体复制成文件
text提示词示例复制到对话框,替换尖括号占位符
python / typescript示例代码需按你的项目调整
diff修改前后对比只看,不复制

2.3 占位符约定

bash
# 需替换为你的实际值 的注释表示:这一行你必须改
claude mcp add --transport http my-server https://YOUR-SERVER.example.com/mcp  # 需替换为你的实际值

提示词模板中的占位符统一用尖括号:

text
请分析 <文件路径> 中的 <函数名>,说明它在 <业务场景> 下的失败模式。

2.4 版本标注

出现「需 Claude Code v2.1.199+」这类标注时,说明该功能有最低版本要求。检查你的版本:

bash
claude --version
claude doctor          # 更完整的安装诊断

三、让 Claude 自己讲解这份手册

这是本手册最推荐的用法 —— 把手册目录交给 Claude Code,让它成为你的私人助教。

3.1 基本用法

bash
cd ~/Projects/LearnClaude   # 需替换为你的实际路径
claude

启动后,Claude Code 会自动加载根目录的 CLAUDE.md,理解本项目的写作规范与目录结构。然后你可以:

text
> 我完全不懂 MCP。用 07 章的内容,给我讲清楚它解决了什么问题,
  并给我一个 15 分钟就能跑通的最小实验。
text
> 对比 docs/08-Skills-从入门到精通/08.5-四种扩展机制怎么选.md 里的四种方案,
  针对我的场景(我需要每次提交前自动跑 lint 和单测),推荐一种并给出完整配置。

3.2 让它帮你续写

本手册被设计成可增量演进的骨架。想补充章节时:

text
> 阅读 docs/06-ClaudeCode-深度解析/ 下的全部文件,理解写作风格。
  然后新建 06.9-性能与并发调优.md,主题是如何在超大仓库中降低 Claude Code 的响应延迟。
  严格遵守 CLAUDE.md 的写作规范,写完后同步更新 README.md 的目录索引。

3.3 让它给你出题

text
> 基于 docs/02-核心篇-提示词工程/ 的内容,出 10 道判断题考我,
  一次只出一道,我答完再给下一道,最后给我一份薄弱点报告。

四、如果你只有 30 分钟

按这个顺序读,能覆盖 80% 的实际收益:

  1. 02.2 XML 标签控制术 —— 单项收益最高的技巧
  2. 04.3 幻觉的成因与锁死方案 —— 决定你敢不敢信它的输出
  3. 05.6 CLAUDE.md 项目记忆 —— 一次配置,长期收益
  4. 04.5 性能压榨 Checklist —— 可勾选的行动清单

延伸阅读

基于 VitePress 构建 · 内容采用原作者授权