如何看英文技术文档

原文地址：https://www.jianshu.com/p/af7d39cac6b8

本文以jekyll官方文档为例。

为小白简单介绍一下，jeyll就是一个静态博客生成器，你只要按照它给定的规则进行相关的配置后，你就可以只要专心写文章，什么数据库管理、自己搭建一个CMS系统等麻烦事情都不要管，也就是你不用写代码，只要写文章就够了，然后在终端输入命令他就会按照你给的配置生成一个静态博客，然后你只要部署就可以了，特别适合我这种”懒鬼”。

前言

在大概两年前的时候，由于一位学长的建议，我把我所拥有的终端设备都换成了英文的，我当时就苦逼了，一个单词一个单词查，好累，有点后悔，但是呢，还是决定坚持，毕竟Big高。

现在回想起来真的非常的感谢那位学长，因为现在看个什么jekyll、sass等什么的官方文档，呵呵，感觉真的还是挺流畅的，毕竟这也是成为一名合格的程序员应该必须具备的技能。

简单概述一下我学习技术英文的过程吧:

1. 刚开始就是把所有设备全部设置成英文的，然后遇到什么就查，做到了看英文不恐惧。

2. 编程过程中，遇到问题的时候先用英文google，看不懂，就用中文。（也正是因为这样的方式，我领悟到了一个道理，但是花了差不多一年半的时间，下文会讲）

3. 与此同时坚持每天半小时的中英文文档对译着看，一般都看翻译的比较好的书，比如现在在看css secret。

就酱，时间静悄悄地流逝，一下子就一年半了，突然我发现我可以“看懂”英文文档了。为什么打个引号呢，因为其实如果一年半之前我知道了一个道理，我当时一样是可以看懂的。

道理竟然如此的简单——英文和中文本质上都是语言对吧！语言就是用来指代事物的对吧！所以说英文和中文唯一的不同就是表达方式不同对吧！换汤不换药对吧！就算你数学是体育老师教的也应该明白多对一的映射吧（见下图）。

映射图

其实看英文看不懂的原因就是你没有理解而已，翻译成中文你也看不懂，所以如果看一份英文技术文档，自己翻译成中文后，还是看不懂，说明是你没理解，真的不要怪英文的问题。说明这份文档不是为你写的，所以你要做的就是看懂你能够看懂的，就换一份英文资料看，不要死磕到那里（这就和你追女神是一个道理，追不到就算了，不要吊死在那里）。要不你就和我一样，找一些相关的中文资料先看看再看英文，这样对你的毁灭性打击比较小，我这样做的原因是我看英文一般只是为了获得更加系统及最新的资料，而不是入门，对于入门来说，中文资料真的够。

举个例子 blog-aware 如果直译的话就是 博客-知道 ，我擦，什么鸟语，然后我就看到了 blog-aware 的解释是如下图，简单就是说jekyll会帮你生成一个静态博客，你只要负责写文章就好了。

blog-aware解释

所以，和上面一样，当你看到一个类似 blog-aware 之类的东西不懂，换一份资料看，说不定就讲的很清楚了，只写了 blog-aware 而没写相关解释的作者假设你已经懂了那个东西的解释了而已。

所以，只要你有基本的英语语法了，你就具备看懂英文技术文档的能力了，英文技术文档基本就没有什么复杂的时态、语态等，都是一些基础的语法，就算有，那一小部分也不足矣影响理解主要意思，不信的话，你可以问下自己一个问题——看中文文档你字字都看懂了吗？所以一般情况丢掉那一小部分就是，不要有完美主义。

有些道理呢就像一层薄纸，你不捅破呢就和捅破了的人在不同的一个世界，这就是李笑来老师经常说的一念一世界。

噢噢，一不小心你和我在一个世界了。。。

以 jeykll 文档为例开始实战

明白了上面这个道理之后，我们来进入今天的正题，如何看英文技术文档。

你是不是也和我一样，首先想一字不落的把文档都看一遍，然后记住，并且忘了之后接着又看了几遍，想考验一下自己的毅力？因为我们都是经过“科举考试”的人啦，考试不就是叫我们把书本记得滚瓜烂熟么，竟然还有个好听的名词，就做“理解记忆”。

很幸运，经过了多份文档的“磨练”之后，我发现有些地方不看也没有关系，咿呀，真的不用看耶，然后慢慢地我跳出了这个坑（我顿时就用一句古文来安慰一下自己——故天将降大任于斯人也，必先苦其心志，劳其胫骨...），并形成了自己的方法，文档真的不用记，知道文档哪里有什么东西，你能够在用到的时候知道查找就可以了（其实这个道理你一定听过，其实我早就听过了，但是那些说这个道理给我听的人，都和放屁一样，根本就不说怎么做，所以我决定写下此文，不再放屁），常用的东西用多了自然就记住了的，不常用的东西你记他干什么？我就是这样被害得到现在为止还是单身狗的，呵呵。

战斗开始，大胆地往前冲啊!!!

冲啊！！！

考察地形

打仗之前肯定要先考察一下地形嘛，肯定先要找到敌人的要害，然后一次性歼灭掉嘛。

jekyll官网首页

打开文档首页，上面的黄色字体就相当于敌人的一个个站点（一般就是链接到文档的不同页面的那几个不大不小的字），开始派侦察兵化为民众去侦查...

HOME

首页嘛，当然一般都会介绍下是个什么东西，干什么的，全部扫一扫。

Transform your plain text into static websites and blogs.，大标题就讲清楚了这个东西用来干什么，好，这一页就差不多了。

其它的Simple，Static，Blog-aware等讲特性的东西一般瞄一眼就好了，没必要深入看，一般都会吹吹牛什么的。

Get up and running in seconds.教我怎么快速运行起来。

最下面讲了host，部署。

好，看完了，过，下一个站点。

DOCS

DOCS 是 documents 的简称，一看就知道大概就是司令部了。

DOCS一进去就看到的首段内容

一进去Welcome 的第一段就说 This site aims to be a comprehensive guide to Jekyll. ，在看看右侧的索引就知道了，应该是司令部。

过，下一个站点。

NEWS

看看右边的索引，好像讲的是新版本发布相关新闻，可以，继续。

COMMUNITY

看看首段，扫扫下面文章的标题，哦，讲的是使用经验分享什么的东西。

可以，继续。

HELP

看了首句Need help with Jekyll? Try these resources.，扫扫下面的内容，讲的是遇到问题怎么解决的帮助信息。

继续。

VIEW ON GITHUB

VIEW ON GITHUB，点开一下就是github的仓库，源码什么的。

进攻司令部

经过上面考察地形之后，我发现了司令部了，DOCS，哈哈，噢耶 \(o)/。

DOCS进去的页面

首先一样看看右边的索引，GETTING STARTED这一部分是要稍微认真一点看的，因为这一部分基本上涉及到了这个技术的所有的内容，就相当于这个技术的全局轮廓图，只是没有涉及到具体的细节罢了，具体的细节具体用到查就行。

准备武器

先准备武器，“检视阅读法”，简单的介绍一下，真的很简单，真的很强大：看每一页的最上面的大标题下的那一小段文字，就能够知道这一页讲什么东西了；看每一段开头的一句或两句话，你就知道这一段讲的是什么内容了；然后看懂了，下面的内容就不看了，跳过——其实这就是为什么有些人说他看文档好快、看书好快，其实用的就是这个方法或者类似的东西。

上面的方法是不是小学老师就教过我们，但是真的直到大学才发现它如此强大呀，说来惭愧，哈哈。

举几个例子。

http://jekyllrb.com/docs/structure/

如上面的图片，看看stores configuration data. 第一句话就知道了，存储配置数据，然后就可以不用看后面的细节了，这里跳过的内容比较少。

http://jekyllrb.com/docs/templates/

看了filter一个字之后，过滤，什么鬼，再看看下面的第一行的例子就知道是干什么的呢，就不看了。这里跳的内容就比较多了，需要了查就行，如果你实在不记得文档有这个东西了，那就找google吧。

总之一个原则，看最少必要的内容，知道这里大概干什么的就够了，不要继续看了，只要能够通过他们知道了到哪里能够查找到什么内容就够了，也就是通过他们了解整个文档的全貌。

有些情况下，你根本不知道那里讲的是什么东西，毕竟是官方文档，为了显得比较专业，就喜欢把简单的东西用鸟语来描述，那就看过就好，知道那个名词，过，知道有那么个东西在就好。比如说开头的 blog-aware，看不懂，拉倒，看过就好，说不定下文就讲到了呢，或者你看的下一份资料。记住，就算看不懂，也要看看——为什么看不懂还要看呢？因为一个东西，你第一遍看不懂，那你就先学其它的，过几天，说不定再来看你就可以看懂了的，说不定是信息缺口或者是大脑需要消化时间呀。并且一个东西你不懂，存在疑惑，只要你认识他了，你的资料当中就会不知不觉的出现好多相关的资料，其实只是你平时没有注意罢了。

千万不要怕错过什么重要的内容，如果你真的错过了什么重要的内容，你的应用肯定就运行不了，运行不了肯定就会有相应的错误提示，有提示就可以google嘛，google了之后肯定就可以找到答案了的。

其实呢，看不懂那个东西其实从一定程度上说明你没有那个东西也没有关系，一样可以运行程序（运行不了就会是上段说的那样子），只是你现在没有那样的需求而已。既然这样，那你死磕啥呢！等到以后，等你想要某个需求功能的时候，但是呢在你看懂了的东西中没有，那就肯定是你没看懂的东西中的，这个时候你google下就好啦，到这个时候再来学习。记住，未知是永远存在的，不是所有的东西你都要弄懂的，学海无涯，带着一定的未知前行未尝不是一件好事，把时间花在对你最重要最紧急并且收益最大的事情上面。

对待这种疑惑，我一般有两种最法：1.这个东西是我常用的，我就会刻意持续地学习它，比如说chrome浏览器，我天天要用它，当然要好好学习嘛；2.不常用的东西，比如说这个jekyll，我就只是搭建我的简历和博客而已，能够写字和部署就够了，我就会遇到需求再来解决。

开始攻击

准备好武器了之后就可以开始攻击了。

依我有限的经验，像get started部分的内容，肯定要认真的看，只不过看不懂不要死磕就行，如文章开头讲的道理，这份资料不适合你，换。

其它的话像右边索引的第二大块 YOUR CONTENT 及以下的内容，就可以开始用“检视阅读法”。

最下面的什么 MISCELLANEOUS 、META ，如果和我一样是菜鸟的话，看看最上面标题下面的那一小段文字知道有那么个东西在就好了，很长一段时间基本上是用不到的。

开始:

1. GETTING STARTED部分内容

   1. 首先扫一下全页的小标题，了解一下全页的逻辑，知道有什么东西。

   2. 然后开始看，看不懂的肯定有，查查不认的单词，能够翻译成不能够理解的中文就够了，过（道理上面讲过）。

   很快就可以看完了，内容不是很多。

2. 重要的内容看完了，就开始用“检视阅读法”开始扫其它的内容了。

   1. 首先扫一下全页的小标题，了解一下全页的逻辑，知道有什么东西。

   2. 使用 "检视阅读法" 扫其它内容，看不懂的肯定有，查查不认的单词，能够翻译成不能够理解的中文就够了，过（道理上面讲过）。

战斗结束

就酱，6个番茄钟(2个半小时，6*25min)，战斗就结束了，好爽，快速的看文档向来是一件让人很爽的事情。

小结

1. 只要你具备了基本的英语语法和词汇，看英文和看中文是没有区别的，看不懂只是你没有理解而了，看不懂就换资料看就行了，不要害怕。

2. 使用检视阅读法阅读文档（除了get started部分外）。

   1. 考察地形，找到司令部；

   2. 使用检视阅读法攻击司令部；

      注意：肯定会有东西你看不懂的，看过就好了，认识它就行了；

3. 知道文档中哪里有什么之后，就可以休息了。

END.