记“程序员”笔记的有效方法是什么[[关闭]

人们的共识似乎是,博客或实体笔记本才是发展的方向。除此之外,你可以使用wiki或OneNote之类的应用程序。

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

一个好的源代码控制系统,有好的代码注释和好的签入注释策略,效果会很好。

• 使用Trac或Github,它们为每个项目提供了一个很好的wiki。除了提交消息之外,您还可以在wiki中保留特定于项目的注释和方法。这有助于文档和团队的其他成员
• 做短期笔记时,随身携带笔记本和铅笔。但如果你像我一样,不久你就会失去这些东西或把它们放错地方
• 在每个项目中保留一个TODO和CHANGELOG文件。有时很难维持,但我已经有很多次,当那些保存了我的a##

我的记忆力很差,预计两周后什么都不记得了(我经常记得,但那时你无法预测你是否会记得某件事)。所以这些是我的适应和工作相当好。

记事本++每天都开在我右边的显示器上。我认为合适的话就加进去 总是 当我提交更改时,将笔记放入subversion。事情变化很快。

我就是这么做的。

人们已经提出了许多方法来实际记笔记,但我认为方法是最重要的。

在我的工作岗位上,我们为许多不同的公司开发定制软件,在每个发薪期结束时,我们都会给他们发一份时间表,他们必须在时间表上签字,我们才能给他们开账单。碰巧这个时间表概述了开发人员所做的所有工作,通常结构是这样的。

打卡-上午8:00

分析-上午10:30
所做分析工作的描述。


所有编码工作的描述。

这样做的目的是向客户证明,当你给他们开账单时,你不是整天都在StackOverflow上。因此,您需要记录您所做的所有编码、调试等。

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

只要简单,任何事情都能成功。如果你开始添加服务器和wiki之类的东西,那么你已经把你想要的东西复杂化了。

TiddlyWiki 真的很方便。这是一个独立的wiki,我用它来记录各种事情的笔记——从我的个人待办事项到关于特定功能实现的笔记。再加上 Dropbox

索引文本文件注释、电子邮件和IM日志。

另外,我有时会在bug/feature请求单中添加一条带有技术注释的注释——清楚地标记为这样,以免混淆非技术性的查看者。

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

• XMind
• vym

除了bug追踪器或计算机化的笔记,我总是有一个日志,我会用它来记下每一天的一些重要的事情。这样我就可以很容易地翻阅一遍,找到具体的日期,看看我写了什么。

纸+笔仍然是一个很好的工具。

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

cat >> ~/TODO

根据您的环境,您可以按照//TODO: 此外,您应该将源代码管理系统设置为拒绝签入而不添加注释。

随着时间的推移,为了让您知道自己做了什么,让下一个人知道如何维护它,最好的方法就是针对所有更改进行单元测试。切换到单元测试的源代码的注释视图,您就有了日期和时间。

我自己的系统是:

• Index cards
• OmniOutliner个人笔记
• OmniFocus待办事项列表
• 与团队共享信息的Wiki
• 博客上的东西可能是程序员普遍感兴趣的地方

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

我的Macbook的Spotlight搜索很善于发现东西,所以我不太担心组织问题。

我在这个网站上找到了TodoList: http://www.abstractspoon.com/ 它很容易使用,不需要安装,并有很好的特点。

为了处理更多的笔记,我建议 WikiPad

我是尼克·塞尼斯的超级粉丝 Todoodlist .

• 使用bug跟踪器、请求跟踪器、设计文档或任何您拥有的东西,新特性和更改也是如此。
• 代码中的注释,用于解释为什么实现是这样的。
• 文档中的注释,用于解释为什么接口是这样的(“基本原理”)。

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

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

虽然这不是所有的技术,我已经成为一个大风扇的 Hipster PDA .

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

吉拉 它设计得很好,但不是免费的

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