阅读文档的8个技巧：新手指南

阅读文档的8个技巧：新手指南

你有没有想过要弄清楚为什么你正在处理的一行代码失败了？你已经重新阅读了代码，已检查过引号，分号和变量名称。你已经确定你没有错过一个支架，却都没有任何帮助。是时候向文档寻求帮助了！

技术文档并不总是易于导航，尤其是对于变成初学者。你在网上找到的文档很少是由同一个人编写的，因此您无法了解一个人的写作风格并进行相应调整。文档里包含的行话新手可能还不知道。一种语言中使用的术语在另一种语言中可能就不再适用。更不要让初学者开始研究每种语言的细节差异，比如使用哪个括号。鉴于这些挑战，我想提供一些阅读文档的技巧。

耐心点。

俗话说，罗马不是一天建成的。就像任何其他学习过程一样，通过阅读文档学习需要时间。如果你开始感到沮丧，请休息一下，稍稍移动你的身体，然后用清醒的头脑重新将注意力回到文档身上。

细心点。

阅读文档时，您会遇到相似的方法，实例和对象的术语，这些术语可能在代码之外具有不同的内涵。经常性的查看关键术语，这样你就可以清楚地了解在文档中运行它们时的含义。

查看技术书籍

在线文档是我们最近首先获取信息的地方，但在线资源可能不完全准确，部分原因在于它们的生成速度。随着技术的变化，印刷书籍可能会过时，但它们可以继续作为基础知识的可靠参考材料。在线阅读文档时，印刷的参考书可以帮助澄清概念。

参考多个来源。

技术文档并不总是将新手考虑进去。因此，易读难度可能存在差距，有时作者认为读者已经掌握了这个知识点。不幸的是，新程序猿不知道他们不知道什么。在多个网站上阅读相同的主题可能会填补经验丰富的程序员可能没有的知识空白。阅读多个网站上的文档还可以帮助您发现哪些资源以适合您的方式进行学习。

阅读概述。

很多时候我们想直接谈到我们试图解决的问题。阅读概述（如果有的话）提供了代码应该执行的框架。阅读文档而不检查概述可能会让忽略许多隐藏在背后的信息。

检查版本。

版本控制和版本号有助于在阅读文档时为您提供指导。检查更改说明和版本信息，以确定何时以及如何解决代码问题。 学习阅读代码。当你试图了解程序正在发生的事情时，阅读文档可能还不够。检查源代码可以在世界上发挥重要作用。利用所有代码示例，不仅通过复制它们，还通过阅读和分析代码正在执行的操作。自己测试代码以查看它的实际效果。改变一切并再次运行。打破它，然后弄清楚如何解决它。

保持代码整洁。

我在编程时学到的第一件事就是保持我的代码干净整洁。所有这些缩进和排列的括号确实有助于阅读代码，并且通过扩展，了解当您阅读文档时发生的事情。在需要找到问题的解决方案时，在前端培养良好的编码习惯会有所帮助。

转载并翻译，原文链接