問題描述
做“程序員”筆記的有效方法是什麼？ (What are the efficient ways to take "programmer" notes?)
I run many times into an issue where someone asked me about a bug or a feature I worked on. And it literally takes me a long time to recall it, usually by looking at Bugzila as well as my CVS reports. So I am trying to find a good way to take notes of what the things I have been working on, and looking for your suggestions. In fact, I usually take almost ZERO notes about what I have done, though I write notes when getting specification or some technical things.
I hear that some people create a new document for each issue or bug they are working on, and append configuration info, log output, my musings and things. I think it is good for weekly/monthly reports and such, plus helps remembering things you've worked on or similar bug you've fixed.
Please suggest how you take note?
‑‑‑‑‑
參考解法
方法 1:
The consensus seems to be that blogs or physical notebooks are the way to go. Barring those, you could use a wiki or an app like OneNote.
Please see this question: https://stackoverflow.com/questions/78756/what‑do‑you‑use‑to‑keep‑notes‑as‑a‑developer
方法 2:
Desk + Crayola
方法 3:
A good source control system with good code comments and a good checkin comment policy works wonders.
方法 4:
- have a blog, even if no one reads it. Write an article/howto/what‑I‑did on anything you figure out that you might want to remember months or years from now. Who knows, somebody else might find it useful too.
- use Trac or Github which provide a nice wiki for each project. In addition to your commit messages, you can keep notes and howto's in the wiki specific to a project. Obv. this helps in documentation and with the rest of your team
- for short‑term notes, keep a notebook and a pencil handy. But if you are like me you will lose or misplace these things before long
- keep a TODO and CHANGELOG file in each project. Sometimes very hard to maintain, but I've had many times when those saved my a##
- if really important, get it tattooed on your arm like the guy in Memento.
I have a pretty bad memory and don't expect to remember anything after 2 weeks (often I do, but at the time you can't predict whether or not you will remember a given thing). So these are my adaptations and work pretty well.
方法 5:
I'm a practical minimalist.
Notepad++ sits open on my right monitor every day. I add to it as I see fit but I always put notes into subversion when I commit changes. Things change quickly.
I used to use tiddlywiki a lot but Notepad++ works better for me and is stripped down to what I need ‑ a place to type that I can search later. The thing I don't like about physical notebooks is that I have to be the search engine when looking for things in one.
That's how I do it.
(by Sasha、mandaleeka、Jason Watts、Paul Sonier、sbeam、itsmatt)