什么是开发者日志?

记录您已经学到的最有用的东西,以便更快地解决未来的问题。
185 位读者喜欢这篇文章。
Writing in a notebook

Pexels,通过 Pixabay。CC0。

计算机科学领域工作最棒的部分之一就是我们的工作重心在于解决问题。虽然我们许多人会开玩笑说,不断努力解决问题令人沮丧,但我们这样做是因为没有什么能比得上找到解决方案的感觉。当然,短暂的兴奋过后,我们又会转向下一个问题。

我们希望我们的解决方案是另一个数据点,推动我们成为更成功和更有效的工程师。但是,当我们遇到旧问题,一个我们已经解决过的问题,却不记得在哪里找到允许我们解决它的那一点点信息时,该怎么办?成为一名工程师常常感觉有点像在过《土拨鼠之日》,总是身处一个你明知道以前已经解决过类似问题的地方。我的解决方案是开发者日志

开发者日志的益处

开发者日志背后的理念是,在执行任务时做相关的笔记可以帮助未来的你。科技行业要求我们不断学习新技术,加深理解,并能够处理对某种工具的快速、一次性使用——这一切都是这项工作的一部分。拥有日志可以帮助您跟踪您的学习。即使您只是短暂地使用某个工具,下次使用该工具时能够参考您的日志也可以限制肌肉记忆的丧失并提高您的回忆能力。然而,这并不是它唯一的益处。

爱因斯坦的建议是“永远不要记住你可以查到的东西”,这是许多工程师铭记于心的概念。选择不记住东西可能会腾出我们大脑中的一些空间,让我们专注于更宏大的问题。然而,当我们查找东西时,我们正在消耗时间和精力,并将自己从开发流程中抽离出来。开发者日志允许我们在记住一切和每次遇到都查找之间取得平衡。如果您要查找的内容是用您自己的语言写成的,并且可以轻松访问,那么您作为工程师的生活就会变得更加轻松。

开发者日志的最终好处之一是士气。我们往往看不到我们日常的进步;只有当我们回顾一段时间时,我们才会意识到自己成长了多少。拥有成长的有形体现是一件美好的事情。也许您在一年前写下了一些东西,现在不再需要参考了。也许您已经从更简单的任务发展到更复杂的任务,或者掌握了以前几乎无法理解的技术。开发者日志是您所做一切的绝佳历史记录。

开发者日志的类型

开发者日志是个人化的,但它们通常包含解决方案、笔记、有用的技巧以及指向资源的快速链接的混合。因为它们是为了适应个人偏好而制作的,所以它们可以采用许多不同的形式。

例如,它们可以是离线的(例如,纸质书写日志)或在线的。数字日志内容可以使用 Markup 或其他工具格式化,如果您喜欢,也可以使用纯文本。日志可以按时间顺序或按主题组织。最后,日志可以是公开的或私有的。

使用任何使您的日志最易于访问和使用,以便记录内容并在需要时查找内容的解决方案。幸运的是,有很多令人难以置信的开源工具可以用来方便您的开发者日志,例如各种Linux 日志应用程序类似 Evernote 的应用程序命令行笔记应用程序

日志中应该放什么

如果您不确定在开发者日志中包含什么,请考虑您经常使用或作为参考的资源类型。日志可能包括代码片段或指向存储库中特定行的链接。常见做法是放置指向特别有用的博客文章或教程的简单链接。我最有帮助的条目之一是我用来将固件刷入板载的流程的简要说明。

这是一个来自我的开发者日志的快速示例。去年,我注意到我经常使用的一个进程会卡住。我一直忘记在终端中手动杀死它的命令,所以我把它写了下来。以下是我的日志条目的屏幕截图。它是纯文本、离线可用且未格式化的。它很简单,并且对我有效。我的日志的时间顺序对我帮助很大,因为我倾向于记住我上次需要答案的时间,即使我不记得答案。

code snippet to kill a process

因此,下次当您发现自己为解决问题而欣喜若狂时,请写下一些快速笔记。下次当您遇到真正有帮助的资源时,请复制链接。几乎更重要的是,记下您下次谷歌搜索的简单语法。拥有一份您自己整理的快速查找内容文档,这些内容最常应用于您的开发流程,是无价的。回顾过去,认识到自己学到了多少,这是一个额外的奖励。

标签
picture of laurie
Laurie 是一位软件开发人员、会议演讲者和经常撰写博客的人。在正常工作时间内,她是 Ten Mile Square 的顾问。根据不同的日子,她可能会使用来自不同语言、框架和其他支持工具的任意数量的技术。当她不编写代码时,你可以发现她在玩棋盘游戏和吃蛋糕。

9 条评论

不,不要记录你学到的东西。记录你所做的一切。这包括没有结果的充满希望的想法、错误的开始、死胡同。工程日志的主要目的是证明你已经完成了工作。这不仅支持专利申请,还能提高你的学习能力。你从错误中学到更多。

没有人直接从 A 点到 B 点。正是糟糕的想法证明了日志的真实性。任何只包含好东西的日志都是无用的。

这绝对是一种有效的方法。开发者日志的重点是帮助您个人,无论这意味着什么。这就是为什么我指出了它可以构建的所有不同方式。它也可以包含各种笔记,我的当然包含了!

回复 作者 Shawn H Corey

我同意 Shawn 的观点,但你也应该记录你所做的一切。从工程角度来看,如果您对所有条目进行日期标记和记录,这些实际上会成为您所做工作的法律记录。如果您因知识产权挑战而被起诉,您的工作日志可以成为支持您立场的强大盟友。好文章和好评论

回复 作者 Shawn H Corey

我同意。当我大学毕业后找到第一份工作时,我为一家政府承包商工作,该公司要求每位工程师都保留一份日志。每天都必须进行记录,详细说明每一天。我的主管必须审查并签名。

公司从中受益,我的一些同事被告知根据他们的条目提交专利申请。当然,根据合同,我们申请的任何专利都归公司所有。

自从养成写每日日志的习惯后,我在之后工作的每家雇主都这样做。

回复 作者 Shawn H Corey

感谢分享,我不断地将所有与工作相关的内容写在子弹笔记(老式纸质)中。我可以打开笔记本并写下操作项,比别人打开手机、平板电脑、笔记本电脑并捕捉想法,然后再转录到需要去的地方更快。几年前我离职时,我把我的笔记本作为过渡文件给了他们。自从我开始工作以来,我把我工作中的一切都写下来了。他们拥有从第一天开始的一切 :-)

或者更准确地说,是“平板电脑”而不是桌子,仍然没有弄清楚如何做到这一点 :-)

回复 作者 Sarah Thornton

只是想贡献一个好的 Web 应用程序:https://www.bookstackapp.com/,这是我朋友最近向我推荐的,我正在开始测试。希望对某些人有用。

感谢您的鼓励。我用 nano 写我的日志,主要关于我在 Linux 系统上所做的事情(更改、破坏、构建)。我想出了一些经典的格式来帮助我浏览文本 (# {date} ==> {explains what it is} ..)

Creative Commons License本作品根据知识共享署名-相同方式共享 4.0 国际许可协议获得许可。
© . All rights reserved.