你是你所记录的

Avatar of Robin Rendle
Robin Rendle

DigitalOcean 为您旅程的每个阶段提供云产品。立即开始使用 200 美元的免费额度!

Yevgeniy Brikman 的这篇文章中有很多小巧的精华,都是关于文档的。但他探讨的不仅仅是代码文档,还关注我们如何记录工作的每个阶段,从设计到流程,乃至更远。

以下是我最喜欢的几句话,让我不禁拍案叫绝!

当开发人员使用你的代码时,他们实际上是在学习一门新的语言,所以要明智地选择其中的词汇。

……程序必须编写得让人易于阅读,而仅仅是附带地供机器执行。

我喜欢 Yevgeniy 的观点,即在编写代码时,我们需要具备两种不同的思维方式:一种是首先让代码运行起来,另一种是解释我们如何以及为何以特定方式进行操作。在这些不同的工作阶段之间存在上下文切换。

总之,从这个角度来看,文档可能远不止锦上添花。相反,它可能只是工作量的 50%。

直达链接 →