作为学习工具写作

我整个夏天写技术教程的经验

克里斯·莱格特(Chris Leggat)摄

在软件开发中,非常需要持续不断的自我学习。 多年来,语言和平台不断变化,而工具,服务和API每天都在变化。 如果您不是每天都在学习新知识,那么您可能会落后。

考虑到这一点,可以说您的学习能力是您最重要的技能。 您无法控制大脑的连线方式,但可以按自己喜欢的方式提供信息。 您可能没有积极考虑它,但是您的学习方法可能是您在学校所教的方式和您经常学习的资源所采用的方法的某种结合。

我是一名动手学习者,并且希望在查看新的API,语言或平台时尽快开始编码。 我通常阅读高级文档并立即开始实施一些具体的东西。 我会根据需要了解更多信息,因此可以立即应用。

尽管这可以帮助我学习,但是我发现在撰写或谈论这些信息之前,我并没有很好地保留这些信息。 我可能会编写简单的嵌入式文档或更详细的系统文档。 有时我创建个人笔记,而其他时候我为同事编写或遍历复杂的实现。 我一直都知道我的大脑会以这种方式最好地吸收信息,但是直到最近几个月,我才学会了更积极地运用信息的方法。

我的写作实验

我最近完成了由教程撰写的iOS 10的六章,涵盖了多个主题。 在此之前,我为raywenderlich.com编写了我的第一个站点教程,该教程分为两部分,涉及CareKit。

这些努力花了我大部分时间。 那么,为什么当其他人都在外面与家人和朋友一起享受生活时,我却把自己锁在书房里? 嗯,原因有很多,包括获得写作经验并回馈令人惊叹的iOS社区。

主要原因与过去2.5年来我一直在raywenderlich.com进行技术编辑的原因相同。 我想学习。 在这种情况下,不仅涉及iOS 10和CareKit,还涉及编写过程。 这本书是实现其他目标的机会,同时也有报酬深入研究iOS 10并尝试写作。

技术编辑涉及研究,代码审查,并花费大量时间来调整技术说明,以使内容更加清晰和关注读者。 我总是会放弃对我可能还很陌生的主题的深入了解的编辑。 因为我已经知道文档可以帮助保留我的职位,所以显然正式写作可能比编辑产生更大的影响。

事实证明,通过编写教程,我学到了很多东西。 每个人的学习方法都不一样,但是我希望分享我的经验会鼓励一些人尝试将写作作为一种学习工具。

养活你的大脑

直到最近,我的大部分写作还是以电子邮件,代码文档和个人笔记的形式。 就像写书一样,这些格式都挑战作者考虑听众。 在解释书面内容时,有必要考虑读者的潜在问题。 为听众写作会迫使您质疑自己的假设,并对主题进行更深入的思考。

当您与他人交流时,无论是书面还是口头交流,都会发生此过程。 甚至非正式的交流也会迫使您组织思想并针对观众进行演讲。

我经常发现自己在描述问题并找到解决方案之前,这些话完全没有说服我。 这是无意的橡皮鸭形式。 这项练习有助于您自己理解中的点,从而提高保留率并可能提供答案。

使用全面的书面教程,您将获得相同的效果。 实际上,我发现针对大量受众的博客文章和书籍会放大效果。 面对更广泛的问题,我感到挑战,因此我的研究更加深入。 我还需要向广大受众提供清晰,简洁和相关的解释-因此我花了很多时间来完善写作。

最后,与观看WWDC视频,阅读帖子或使用API​​相比,我在内存方面的知识更加坚定。 我指出了以下三个主要原因:

  • 动机 :我不想误导读者,而是想尽可能地展现自己。 因此,我花了很多时间来研究主题,以确保我完全理解它。 一旦我掌握了这些知识并将其转换为简洁明了的输出,就可以更整洁地将其归档在我的大脑中。
  • 观点 :学习新知识时,很容易掩盖细节。 掌握有关基础的知识或假设的最简单方法是开始向某人解释一个复杂的主题。 以这种方式访问​​内容使我对内容有了更深入的了解,从而改善了我的解释和知识保留。
  • 重复 :与我不打算教书相比,我在这些主题上花费的时间更多。 我必须学习内容,通过示例项目应用它,编写它,然后从中删除废话。 每个阶段都是基于先验的,这使我以不同的方式考虑信息。 我发现这些多种方法对我的理解和信息保留产生了复合影响。

这些是我的轶事观察,但是如果技术写作对许多其他人没有同样的帮助,我会感到惊讶。 从许多不同的角度来探讨一个话题并深思熟虑可以极大地改善您的学习过程,这是有道理的。

下次您需要学习新内容时-尝试写博客。 即使刚开始时受众不多,发布也会提供动力并迫使您考虑受众的角度。 思考一下博客如何影响您的保留率,您可能会感到惊讶。 如果没有其他问题,将来您需要有关该主题的复习时,您将获得大量资源!