language-agnostic - 做“程序员”笔记的有效方法是什么？

Question

我多次遇到一个问题，有人问我有关我工作的错误或功能的问题。我确实需要很长时间才能回忆起它，通常是通过查看 Bugzila 以及我的 CVS 报告。所以我试图找到一个好方法来记录我一直在做的事情，并寻找你的建议。事实上，我通常对我所做的事情做几乎零笔记，尽管我在获得规范或一些技术性的事情时会写笔记。

我听说有些人为他们正在处理的每个问题或错误创建一个新文档，并附加配置信息、日志输出、我的想法和事情。我认为这对每周/每月报告等很有用，而且有助于记住您从事的工作或您已修复的类似错误。

请建议您如何记笔记？

score 7 · Accepted Answer

共识似乎是博客或物理笔记本是要走的路。除了这些，您可以使用 wiki 或 OneNote 之类的应用程序。

请看这个问题：https ://stackoverflow.com/questions/78756/what-do-you-use-to-keep-notes-as-a-developer

score 6 · Accepted Answer

6

书桌 + 绘儿乐

于 2009-06-19T18:17:27.940 回答

score 6 · Accepted Answer

具有良好代码注释和良好签入注释策略的良好源代码控制系统可以创造奇迹。

score 5 · Accepted Answer

有一个博客，即使没有人阅读它。写一篇文章/howto/what-I-d关于任何你想在几个月或几年后记住的事情。谁知道呢，其他人可能也会觉得它有用。
使用 Trac 或 Github，它们为每个项目提供了一个不错的 wiki。除了提交消息之外，您还可以在特定于项目的 wiki 中保留注释和操作方法。观察。这有助于文档和团队的其他成员
对于短期笔记，请随身携带一个笔记本和一支铅笔。但是如果你像我一样，你很快就会丢失或放错这些东西
在每个项目中保留一个 TODO 和 CHANGELOG 文件。有时很难维护，但我有很多次救了我的 a##
如果真的很重要，请像 Memento 中的那个人一样将它纹在你的手臂上。

我的记忆力很差，不希望在 2 周后记住任何事情（我经常这样做，但当时你无法预测你是否会记住某件事）。所以这些是我的改编并且工作得很好。

score 3 · Accepted Answer

我是一个实用的极简主义者。

Notepad++ 每天都在我的右显示器上打开。我会在我认为合适的时候添加它，但我总是在提交更改时将注释放入 subversion 中。事情变化很快。

我以前经常使用 tiddlywiki，但 Notepad++ 对我来说效果更好，并且被精简到我需要的地方 - 一个我可以稍后搜索的输入位置。我不喜欢实体笔记本的一点是，当我在一个笔记本中查找内容时，我必须成为搜索引擎。

我就是这样做的。

score 3 · Accepted Answer

人们提出了许多记笔记的方法，但我认为方法是最重要的。

在我的工作中，我们为许多不同的公司开发定制软件，并且在每个支付期结束时，我们都会向他们发送一份时间表，他们必须在该时间表上签字，以便我们向他们收费。恰好这个时间表概述了开发人员所做的所有工作，通常结构是这样的。

打卡 - 上午 8:00

分析 - 上午 10:30
完成的分析工作的描述。

编码 - 下午 12:30
描述完成的所有编码工作。

这样做的目的是向客户证明，当您向他们计费时，您并非整天都在 StackOverflow 上。结果，您记录了您所做的所有编码、调试等。

尽管我是第一个承认这个过程很痛苦的人，但我数不清有多少次我回去查看我过去的时间表，看看我是如何解决我再次遇到的问题的，或者弄清楚我在一段时间内没有接触过的某个项目上的中断点。这很棒。

score 2 · Accepted Answer

2

写博客。或者为开发者笔记设置一个内部 Wiki。

于 2009-06-19T18:19:15.363 回答

score 2 · Accepted Answer

你想要简单，这样你就可以很快进入。我使用一个文本文件并将其添加到桌面上，并在添加新条目时保留一个标准名称，例如 NOTES、NOTES2 类型的 README 或 TODO 格式，并带有日期。

只要简单，任何事情都会奏效。如果您开始添加服务器和 wiki 以及所有这些东西，那么您的需求就过于复杂了。

score 1 · Accepted Answer

另一种记笔记的方法是使用思维导图。掌握它需要一点时间，但我发现这些对于组织我对各种主题（包括编程任务）的想法非常有价值。我什至修补了一个工具，将我的思维导图直接转换为可粘贴到 Jira 注释中的嵌套列表：) 使代码阅读注释和设计/估计注释非常易于构建和更改。

一些适用于思维导图的工具：

XMind
vym（查看你的想法）

score 1 · Accepted Answer

我发现TiddlyWiki真的很方便。这是一个独立的 wiki，我用它来记录各种事情的笔记——从我的个人待办事项到关于特定功能实现的笔记。将它与Dropbox结合起来，它就会出现在我的所有系统上。

score 1 · Accepted Answer

安装桌面搜索引擎。索引文本文件注释、电子邮件和 IM 日志。

此外，我有时会在带有技术说明的错误/功能请求单中添加评论——明确标记为这样，以免混淆非技术观众。

score 0 · Accepted Answer

我从这个网站找到了 TodoList：http ://www.abstractspoon.com/ 它很容易使用，不需要安装并且有很好的功能。

为了处理更多的笔记，我推荐WikiPad，它可以让你组织信息。

score 0 · Accepted Answer

除了错误跟踪器或计算机化笔记之外，我总是有一本日志，我会用它来记下每天某种形式的重要事项。这样我就可以轻松地翻页并找到特定的日期并查看我在那里写下的内容。

Paper + Pen 仍然是一个很棒的工具。

score 0 · Accepted Answer

我已经使用 Moleskine 笔记本很长时间了，每当我转向其他东西（我使用过 OneNote、WikidPad、Tomboy 等）时，我总是回到我的笔记本

Moleskine 有各种尺寸，更不用说至少 3 种类型的纸张：普通纸、直纹纸、网格纸

http://www.moleskines.com/moleskine-softcover-xlarge-squared.html

希望这可以帮助

score 0 · Accepted Answer

0

我cat >> ~/TODO在笔记本（物理）中使用、写博客或写下来。

于 2009-06-19T18:26:08.673 回答

score 0 · Accepted Answer

根据您的环境，您可以按照 //TODO 的行制作自定义标签：此外，您应该将源代码控制系统设置为拒绝没有注释的签入。

随着时间的推移记录某些东西，让你知道你做了什么并且下一个人知道如何维护它的绝对最佳方法是针对你的所有更改进行单元测试。切换到单元测试源的注释视图，您就有了日期和时间。

我也喜欢一张便条，它可以轻松拖放任何格式，而且您不必担心打开、保存等任何事情，只需让它运行，它会处理细节。

score 0 · Accepted Answer

我自己的系统是：

索引卡，用于立即记下我需要记住或参考的事情。（几乎所有这些都会在一天结束时被扔掉。）
用于个人笔记的 OmniOutliner
OmniFocus 待办事项列表
错误跟踪系统注释，以获取有关跟踪和修复错误的信息
与团队共享信息的 Wiki
博客，内容可能是世界各地的程序员普遍感兴趣的东西

通常，事情从 OmniOutliner 开始，然后根据需要复制并粘贴到其他系统。

我的 Macbook 的 Spotlight 搜索很擅长找东西，所以我不太担心组织问题。

score 0 · Accepted Answer

与特定问题调查有关的注释的错误跟踪器。这可以包括测试代码、日志输出、更新您如何缩小范围以及您已排除的内容。我试着假设我会被公共汽车碾过，明天会有人接管这个错误。他们将拥有错误跟踪器注释、我 PC 上当前工作目录中的任何代码，并且可以假定无法读取我的笔迹。他们希望最迟在上午 10 点之前到达我所在的位置。它当然应该包括对导致错误的问题的完整描述，以及它是如何修复的，以供历史记录。当有人问“那个错误修复到底是什么？”时，这就是你会去的地方。如果有人说“我在其他地方看到过类似的问题，
使用错误跟踪器、请求跟踪器、设计文档或任何您拥有的任何新功能和更改也是如此。
注释中的代码注释解释了实现的原因。
文档中的注释用于解释接口为何如此的注释（“基本原理”）。

我不喜欢只为我保留关于我的代码的个人笔记，即使在理论上公开的 Wiki 或博客上也是如此。没有其他人会在需要它们时找到它们，除非可能 (1) 你有一个非常好的内部搜索工具，以及 (2) 每个人都在大量写博客，这样其他人就会期望有一些值得搜索的东西。如果注释与代码有关，那么它们应该在代码或其文档中，或者至少在错误跟踪器中（它解释了以前代码的问题，而注释解释了当前版本的正确之处） .

诸如“我必须做些什么才能安装和运行 IDE”之类的注释，当然，它们会出现在 wiki 或博客中。公开的东西，或者你的同事可以看到和搜索的东西，但它是特定于你的，因为你是最有可能想要它的人。

如果您正在研究开源代码，那么写博客可能是更好的选择，因为世界上任何人都可能想知道它，并且可能会在整个网络上搜索信息。但我从未参与过重要的开源项目。

score 0 · Accepted Answer

0

我是 Nick Cernis 的Todoodlist的忠实粉丝。

于 2009-06-19T22:50:39.387 回答

score 0 · Accepted Answer

虽然这不是那么技术，但我已经成为Hipster PDA的忠实粉丝。

（简而言之：一堆 3x5 卡片和一个活页夹。它实际上非常有用。）

score 0 · Accepted Answer

0

我喜欢jira它的设计非常好，但不是免费的

http://www.atlassian.com/software/jira

于 2011-04-21T22:54:07.920 回答

language-agnostic - 做“程序员”笔记的有效方法是什么？

21 回答 21

Related

Reference