什么是开发者日志?

记录你已经学到的最有用的东西,更快地解决你未来的问题。
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} ==> {解释它是什么} ..)

Creative Commons License本作品根据 Creative Commons Attribution-Share Alike 4.0 International License 许可。
© . All rights reserved.