跳转到内容

阅读英文技术文档

非母语开发者阅读英文技术文档时的常见问题:

  • ❌ 整段读不懂,需要逐句翻译
  • ❌ 遇到陌生表达就得查词,打断工作流
  • ❌ 看完了忘了,或者把表达方式记住了却不会用
  • ❌ 文档里的例句写得好但学不到(没地方存)

工作流 1: 快速查词(不打断工作)

Section titled “工作流 1: 快速查词(不打断工作)”

你在读文档时遇到陌生短语,需要快速理解但不想中断。

Reading: "This design pattern leverages polymorphism
to achieve decoupling between layers."
遇到: "leverages" — 快速查词

操作:

  1. 选中 “leverages”
  2. 按 ⌘⇧D(全局快捷键)
  3. DevGlish 浮窗出现,显示定义和发音
  4. 读一遍,关闭(⌘W)
  5. 继续读文档

工作流 2: 段落模式(深层理解)

Section titled “工作流 2: 段落模式(深层理解)”

你遇到了整段不理解的内容,需要逐句拆解。

例子:Python 文档的描述

Original paragraph:
"The descriptor protocol is a beautiful piece of Python that
allows you to define what happens when an attribute is accessed,
modified, or deleted. This is achieved through special methods
__get__, __set__, and __delete__, which must be defined on
descriptor objects."

操作:

  1. 复制整段
  2. 打开 DevGlish 段落模式(菜单 → Paragraph Mode)
  3. 粘贴文本
  4. 看 Claude 的逐句分解
DevGlish Paragraph Analysis:
Sentence 1: "The descriptor protocol is a beautiful piece of Python..."
Breakdown: descriptor protocol = Python 特性,允许你定义属性访问的行为
Key words: protocol (协议), descriptor (描述符)
Sentence 2: "...when an attribute is accessed, modified, or deleted."
Breakdown: 三种操作 — 读取、修改、删除
Sentence 3: "This is achieved through special methods..."
Breakdown: 通过三个特殊方法实现(__get__, __set__, __delete__)
Summary: Descriptor protocol 让你自定义属性访问行为,通过特殊方法实现。

工作流 3: 保存优质表达(积累库)

Section titled “工作流 3: 保存优质表达(积累库)”

在读文档的过程中,你发现了好的表达方式。保存它们,后续可以在自己的代码审查或文档中使用。

例子:

读 Kubernetes 文档:

"A controller watches the shared state of the cluster through the API
server and makes changes attempting to move the current state towards
the desired state."

这句话的表达很专业,你想学会这种方式。

操作:

  1. 选中这句话
  2. ⌘⇧D 打开 DevGlish
  3. 点「保存」(📌 按钮)
  4. 标签为 “technical-writing” 和 “kubernetes”
Saved to Word Book
Expression: "A controller watches the shared state of the cluster
through the API server and makes changes attempting to move the
current state towards the desired state"
Tags: #technical-writing #kubernetes

后续在写 PR 或技术文档时,可以搜索这个标签,复用或改编这个表达。

遇到复杂概念时:

  1. 用段落模式理解文档解释
  2. 读完概念后,再看代码例子
  3. 如果还是不清楚,搜索 YouTube 上的讲解视频

遇到表达时有三种选择:

处理方式场景例子
快速查词(不保存)理解即可,短期内用不上”parameterize”(参数化)
保存但不复习好的表达,可能后续用”achieves decoupling”(实现解耦)
保存 + 复习常用的,需要主动掌握”race condition”(竞态条件)
文档类型读法何时保存
API 文档快速扫,查陌生词参数描述、常见用法
教程段落模式逐句理解好的解释句、例句
设计文档专注概念,忽略细节架构描述、设计权衡解释
博客文章整段读,遇到模糊的用段落模式观点表述、最佳实践表达

你读了一段文档,理解了意思,但想学会用英文表达这个概念。

例子:

文档说:

"Async/await is syntactic sugar over promises that makes asynchronous
code look more like synchronous code, improving readability."

你想用自己的话解释这个概念。用 Express 模式:

Input (你的理解,用中文): "Async/await 是在 Promise 基础上的语法糖,
让异步代码看起来像同步代码,更容易读"
Basic (Direct):
"Async/await is syntactic sugar over promises that makes
asynchronous code look like synchronous code, easier to read"
Intermediate (Natural):
"Async/await simplifies promise-based code by making it look
more like traditional synchronous code"
Native (Idiomatic):
"Async/await lets you write asynchronous code that reads like
synchronous code, without callback hell"
💡 Tip: 提到了 async/await 解决的实际问题(callback hell)

选择 Intermediate 或 Native,记住这个表达方式,下次在代码审查或文档中就能用。

错误理解原因正确理解
”achieves” = 成就太字面”achieves decoupling” = 实现/达到解耦
”leverage” = 杠杆太技术”leverage X” = 利用/充分使用 X
”the pattern” vs “a pattern”中文无冠词”the” = 之前提过的,“a” = 某个具体的
”allows X to do Y” 是被动?实际是主动”allows” 的主语是 X,表示 X 可以做 Y

第 1 阶段:简单文档(入门级)

Section titled “第 1 阶段:简单文档(入门级)”
  • Django 新手教程
  • 官方 API 入门指南
  • 中等难度的博客文章

**策略:**快速查词 + 偶尔段落模式

**保存率:**5~10% 的新表达

  • Kubernetes 官方文档
  • 大型开源项目的设计文档
  • 高质量的技术博客

**策略:**段落模式处理复杂句子,段落模式处理陌生概念

**保存率:**15~20% 的新表达

  • 学术论文(涉及你的领域)
  • 复杂的 RFC(Request For Comments)
  • 深度技术分析

**策略:**先读中文总结或视频讲解,再读原文,用段落模式处理每个段落

**保存率:**20~30% 的新表达(都是高价值的)

按钮动作场景
快速查词(⌘⇧D)选词 → 快速浮窗 → 看定义 → 关闭需要快速理解,继续读
段落模式复制段落 → 粘贴 → 获得逐句分解整段不懂或想深入理解
保存(📌)选表达 → 查词时点保存好表达,要后续复习或使用

读技术文档时,时间分配:

  • 50% — 理解主要概念(快速查词,段落模式)
  • 30% — 读代码例子,跟着做
  • 20% — 保存优质表达,加入生词本

不要花太多时间在单个表达上。“好到 80%“就继续,不要追求 100% 完美理解。