代码日志里应该写些什么？代码日志记录（第 3 部分，共 4 部分）

在我的代码日志系列的第三部分中，我将介绍一些关于如何在代码日志中实际记录内容的想法。这些只是一些想法，你应该选择适合自己的方法。

你还有什么其他想法可以写在代码日志里吗？请在下方评论区留言。

写什么

如果你不知道写什么，那就写吧。每天写几句话，整理思绪或记录你的所作所为，是一个不错的开始。话虽如此，以下是一些关于跨页（一页或多页）的创意，你可以参考一下。

无论如何，开始写作吧。水龙头不打开，水就流出来。

路易斯·拉穆尔

索引和/或章节索引

这是你在笔记本中应该创建的第一件事。要在笔记本中创建索引，只需在代码日志的开头留出 2-4 页，并将其命名为“索引”。有些笔记本有页码，如果没有，你只需在使用时对页面进行编号，并将其内容写入索引即可。

章节索引是一个实用的工具，可以更全面地细分你的笔记，并根据笔记类型进行分组（我稍后会讨论一些章节索引的概念）。其基本思路是，将章节索引添加到你的“索引”中（例如 p8 项目索引）。然后在“章节索引”页面上，为该类型的笔记创建一个索引（例如 p9 项目客厅、p.23 Minki Inc. 等）。这种分组意味着你无需搜索整个主索引来查找所需内容，只需找到相应的“章节索引”，并在这个较小的索引中找到它即可。

对于数字代码日志，索引的形式会根据你的设置方式和使用的平台而有所不同。使用 Evernote 时，你可能会使用不同的数字笔记本和标签，并可能使用笔记作为索引。如果你使用在线文档，例如 Google Docs/Drive，那么你可能需要使用文档作为索引，并使用文件夹来整理文档。数字日志中的搜索功能会很有帮助，但一目了然地查看笔记内容也是一件好事。

定期/每日笔记

即使你不是每天都做笔记，在编程时养成记录的习惯也是有益的。记录的内容可以只是关于下一步要做什么，但关于你做出某个决定的原因，或者你对自己或他人编程的观察，这些都会在你日后回顾时派上用场。记录下下一步要做什么，当你下次回到这个项目时，可以节省大量时间。

目标追踪

许多人设定了年度/季度/月度目标，但当时间到了，他们如何知道自己是否已经达成目标？他们是否还记得要为之努力？

保持你的目标，将它们分解成几个步骤，并在你的代码日志中记录你实现目标的进展情况，这意味着你可以建立一个回顾你的目标和进展的仪式，使你更有可能在预定的时间内实现你的目标。

你的目标是在明年学习一门新的编程语言吗？把它写下来，并列出你需要采取的步骤（或者至少是下一步），并记录你为实现目标所做的一切。当你观看课程视频、参加聚会或编写代码时，记录你的进度。

养成定期回顾目标的习惯，至少每月一次（短期目标可以更频繁）。这能让你保持清晰的思维，并推动你朝着每个目标迈进。

培训与技能

除了正式培训，你很可能还会在非正式场合学到很多东西。记录你目前的技能和学习情况，对设定未来目标、更新简历或申请加薪或晋升大有裨益。

您可以有一个页面来记录有关特定主题的任何学习内容，或者一个页面来记录有关所有内容的所有学习内容，或者您​​可以有一个页面来记录课程，一个页面来记录视频课程等。代码日志应该适合您，因此您可能需要进行尝试。

项目跟踪

跟踪您的项目是一个好主意，无论它们是您日常工作中从事的项目还是个人项目。

这是你经验的一部分，在准备面试、更新简历或争取升职加薪时，它和记录你的培训和技能一样有用。它还能帮助你弄清楚自己喜欢什么、不喜欢什么，从而更好地规划你未来的编程之路。

技术

关于您所使用的技术的记录对于未来规划、简历、加薪等也非常有用。当您寻找问题的解决方案或担任架构师角色时，这也是非常有用的记录。

记录你使用过的技术、使用方法以及研究过的技术是一项宝贵的资源。下次你寻找解决方案时，可以快速找到过去放弃的技术以及放弃的原因。你还可以了解某项技术的优缺点，从而快速判断它是否能解决你的新问题。

记录有用的技术资源，或者如何使用特定语言解决问题，当您想要再次使用该技术时，这将成为您的有用资源。

成功、失败与赞扬

当你取得成功或因某事受到赞扬时，你应该记录下来，这不仅是为了在要求加薪之类的事情上用到，也是为了在情况不那么乐观时提醒自己一些积极的事情。回顾过去的成功和赞扬可以帮助你摆脱冒名顶替综合症（如果你正遭受这种困扰）。口头赞扬尤其值得记录，因为你没有其他记录。

记录你的失败也很重要，这并非为了贬低自己，而是为了从过去吸取教训，避免将来重蹈覆辙。为什么会出错？事后想想，你会怎么做？这件事可以预见吗？以后你会如何避免再次发生？它是如何解决的？它是否可以用更好的方法解决？

决策

在你的项目、技术研究、目标和未来规划中，记录你、你的团队以及其他人的决定是有益的。这将节省你未来的时间，因为你将记录下你做出决定的原因，从而避免再次做出同样的决定。

如果你需要向某人汇报项目进展，或者某件事进展顺利或不顺利的原因，这份记录也会很有用。如果你记录了项目朝某个特定方向发展的原因，那么这个过程就会容易得多。

开始做 | 继续做 | 停止做

这是一个值得定期进行的回顾，例如每月、每季度、每年，甚至在开展新工作时每周都可以进行。它能让你有机会分析哪些工作对你有效（继续做），哪些工作对你无效（停止做），以及如何改进（开始做）。

这个过程是将敏捷实践融入到你自己的工作和流程中的好方法。你不断地尝试和调整，每天、每周或每月都能提升自己一点点。

你的每一个行动，都是对你渴望成为的人的投票。没有任何一个单一的举动能够彻底改变你的信念，但随着投票的累积，你新身份的证据也会逐渐增多。

詹姆斯·克利尔

未来与职业规划

与目标类似，但时间跨度更长。你对未来和职业的目标可能会随着时间的推移而改变，也可能不会。记录你对未来的想法和设想，可以帮助你设定短期和中期目标，从而帮助你实现目标。

随着经验的积累，你可以更新这些计划，甚至转向完全不同的方向。以这种方式使用代码日志可以帮助你规划并牢记计划，从而确保你始终朝着目标前进。定期思考未来，可以避免在不想走的路上走得太远。

下一步是什么？

在本系列的下一篇文章中，我将介绍一些有关如何充分利用代码日志的技巧。

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