如何高效使用官方文档?


让我们一起来复盘一下,

一名IT小白在成长的道路上,一定会遇到的那些坑。

方法不对,事倍功半;方法正确,事半功倍,让我们一起来看一下吧。


...

何时学习文档?


学习比较成熟的技术框架时,官方文档是首选。
并不是说其他的学习资料不够好,而是官方文档会提供准确,权威的资料。
还有什么能够比从一帮创造者的手里学习更直接的方式呢?
通过官方文档入手,能够保证认知上不会有太大的偏差,远胜过在网上搜到的那些质量参差不齐的资料,教程,特别是在初学时能力不够,无法分辨质量的高低。
...

避开学习偏见


学习官方文档不代表排斥其他学习资料,实际上在后续的阶段一定会学习其他的资料。
相对成熟的技术框架才合适,较新的技术自身都不完善,更不要说文档了。
基础语言,工具的学习,文档并不能提供给太多的帮助,这方面有很多更合适的经典资料。
...

端正态度思想


在开始之前,要保持好心态。
开启一段探索未知之旅,永远都是很难的事儿,这和你看的是啥材料无关。不要企图去寻找最好的教程。
在中途遇到了困难,这很正常,找到问题并解决它。不要学了一点儿,在中途转而去寻找其他的教程。
这就像一个挖金矿的过程,不挖到金子是不会知道金子在哪儿。好不容易挖到70%放弃了,重头开始再来,挖到80%,再放弃,然后,重复这个过程...

同时,还需要有明确的实践项目,你想通过这个技术来构建什么?
这是很重要的条件,文档上的新手向导和最佳实践是完全不够的。只有在做真实的东西时,才会发现问题,引导你去深入理解,解决问题。

开始的第一件事儿,就是熟悉文档结构。
先把文档的结构看明白,都有哪些内容,在什么地方能够找到,有没有推荐的阅读内容。
...

熟悉文档结构


通常文档都有三个重要内容。

新手向导
英文文档中通常为Tutorials,Getting started等部分,一步步教你如何搭建一个简单的应用实例。

理论知识
阐述该技术关键知识,概念和一些必备的背景知识。

API文档
英文文档中通常为Reference guides等部分,包含了具体API使用细节以及相关的一些机制。
...

遵循科学方法


从新手向导开始。不要直接去阅读大段的文档,这样十有八九是会放弃的。
谁也不会为了开一辆车去把车辆说明书的所有部分都读上一遍。
说明书的大部分内容不是核心内容,并且在没开始之前,谁也没办法分辨什么是真正关键的地方。

新手向导面向的就是对这门技术完全不熟悉的人。
所以如果这时候遇到了问题,检查下,语言基础有没有问题?是不是有理解不到位的地方? 老老实实的回头去学扎实了,笨办法才是是最好的办法。
学习过程中一定会遇到新的知识,概念,不懂。怎么办?
先记下来,把新手项目做完,完成后,继续做新手向导,重点是搞清楚之前留下来的那些问题。
接下来,文档结构就派上用场了,到里面去查找遇到的问题,知识点,一个一个解决。
完成这遍向导之后,对如何构建一个最简单的应用场景,心里就应该比较清楚了。

然后开始你自己的实战项目,实战项目可以直接以新手向导为样本,逐步来添加需要的功能点。
光靠文档的知识有可能不能完全解决你的问题,这时就需要类似 StackOverflow 等论坛的帮助了。

突破核心知识点,补全基础知识,完成一个功能点之后,停下来,解决之前积攒下来的问题。 不断重复这个过程,直到完成整个实战项目。
虽然完成了整个内容,但是其实这个阶段还很初级,更谈不上健壮。怎么办?继续练。
仔细阅读自己之前写的那些代码,重新构建功能点,尝试在有问题地方,通过阅读源码来搞清楚原理,背景。
把自己对这些问题理解记录下来,在以后的学习中,反复去验证这些想法,不断修正。