为什么要记录代码日志 | 代码日志(第 1 部分,共 4 部分)

2025-05-25

为什么要记录代码日志 | 代码日志(第 1 部分,共 4 部分)

替代文本

写日记通常被认为是一种艺术性或整体性的消遣,是那些富有创造力或有太多空闲时间的人才会做的事情。为什么技术人员会对写日记感兴趣呢?

日志是一种工具,代码日志是任何使用技术(不仅仅是代码)的人的工具,无论是在工作中还是作为业余爱好(开发人员、软件架构师、QA/测试人员等)。

刻板的日记类型通常被认为是改善心理和精神健康的工具,而代码日记则是改善您的编码和工作/业余生活的工具。

在这篇文章中,我将探讨几个你应该保留代码日志的理由。在本系列的下一篇文章中,我将提供一些关于如何开始使用代码日志的建议。代码日志没有硬性规定,你的代码日志将根据你的个人需求进行定制。

保存代码日志的好处

把所有事情从你的脑海中清除掉

如果你想记住要做的事情,并想解放你的大脑去做它应该做的事情(思考!),那么你需要把所有事情都从你的脑海中清除掉。使用代码日志可以让你避免丢失那张至关重要的便利贴,上面写着你改变世界的想法。你的大脑会感谢你让它思考,而不是记忆。

你的头脑是用来产生想法的,而不是用来保留想法的。

大卫·艾伦

追踪你的成长

你可以追踪自己的进步,看看自己取得了哪些进步。如果没有记录,很难看出自己取得了多大的进步。我们大多数人都会在某个时刻感到自己停滞不前,或者落后了。你的代码日志可以向你展示你正在进步,也可以帮助你识别你缺少什么,并设定目标。

追踪您的目标和进度

您可以追踪您的目标及其进展。将目标放在首位并追踪进度,将帮助您更快地实现目标。代码日志为您提供了记录和回顾目标的空间,让您能够按时完成设定的目标。

选择足够大的战斗以取得重要胜利,选择足够小的战斗以取得胜利。

乔纳森·科佐尔

节省时间

有了代码日志的记录,你就能更轻松地继续之前中断的工作。即使项目已经过去很久了,你也无需再浪费时间去回忆项目进展到哪里,或者下一步计划做什么。

更轻松地管理多个项目

在项目之间切换会更容易。大多数人同时进行多个项目,查看项目之前的笔记可以让你更快地重新开始,并提醒你接下来需要查看的内容。

制定编码或工作理念

代码日志将帮助你形成一套编码哲学。思考和分析你的编码方式以及你自己(或团队/公司)的流程,可以帮助你识别哪些方法有效,哪些需要改进,以及如何将新的想法融入你的编码中。最终的结果应该是更加精简的流程和代码库。

记录哪些有效,哪些无效

你可以记录哪些事情做得好,哪些做得不好。有了参考,你就能知道哪些事情应该继续做,哪些事情应该停止做,哪些事情应该开始做,这能让你不断进步。保持记录并定期回顾是进步的关键。

跟踪决策

你可以记录你对项目、学习等所做的决定。你还记得为什么做某个决定,或者这个决定实际上是什么吗?如果你现在有了更多信息来支持这个决定,你就可以判断是否需要重新考虑这个决定。这样你就可以参考,避免再次做出同样的决定,从而避免浪费时间。

缩短上市时间

记录功能和重构想法,以减少功能蔓延。这是一个很容易掉入的陷阱,尤其是在个人项目中。如果你不断在当前开发周期中添加新功能,你将永远无法部署该应用!记录新功能和重构想法意味着你不必担心忘记你的想法,并且可以在未来的版本中考虑它们。

今天交付的优秀软件往往比明天交付的完美软件更好。

《程序员修炼之道》

识别并消除瓶颈

你将更容易发现瓶颈或任何阻碍你进步的因素。识别需要调整的地方或需要学习的技能,将加快你作为程序员的成长速度。相比其他领域,改进瓶颈可能会让你的努力获得最大的回报。

除了瓶颈之外的任何地方所做的任何改进都只是幻想。

吉恩·金

发现你的快乐

你为什么喜欢你正在做的事情?你享受什么?弄清楚这些问题,你就能专注于那些让你在编程中感到快乐的事情,从而提升你每天的幸福感,并帮助你设定目标,让你更进一步地追求那些让你快乐的事情。回顾你的代码日志能帮助你更快地找到这些问题。

我一直认为,如果人们在重要时刻突然唱起歌来,他们会在日常生活中找到更多的乐趣。

约翰·巴罗曼

收集证据以获得晋升或加薪

大多数公司都会要求你提供充分的理由,才能申请加薪或晋升。你的代码日志是记录你一直在做的事情的理想场所,尤其是你的成功和他人的赞扬。别忘了记录你工作职责之外的事情,比如你正在参与的开源项目。你还可以记录你对当前职位或你渴望的职位的市场薪酬的研究。

轻松更新简历并准备面试

在更新简历和练习面试答案时,代码日志将是你最好的帮手。它记录了你使用过的技术、参与过的项目、解决过的问题、以及你应对困境的方式……如果这份清单听起来有点像面试题准备清单,那么你可能会觉得,参考代码日志来准备这些常见的面试问题,比费力地回忆过去几个月或几年做过的所有事情要容易得多。

下一步是什么?

在本系列代码日志的下一篇文章中,我将介绍如何开始使用自己的代码日志。

替代文本

最初于 2019 年 9 月 9 日发布于http://www.jacqui.tk/blog

文章来源:https://dev.to/jacquibo/why-you-should-keep-a-code-journal-code-journaling-pt-1-of-4-k35
PREV
每个开发人员都应该知道的 20 个 Git 命令行技巧
NEXT
使用 Svelte 的 Svelte Web 界面