Live data from Hacker News

The software engineering notebook

winterflower.github.io

11–20 of 143 posts

Re: The software engineering notebook

#11
post #9

Usually they're work specific notes for my coworkers, its always nice to share a line by line account of your build process when you're using some arcane systems that require being built from source with really complex configuration issues to handle.

The only tool I use are markdown files and gitlab to do this, I've found the .md markdown format to be extremely useful compared to the bad old days of emailing word docs.

Re: The software engineering notebook

#13
The commitment to taking good notes has been one of the best decisions of my life -- not just professionally. I use my standard text editor (Textmate 2), and have a "notes" project, with all manner of categories organized by folder. I take notes on articles I have read, take notes on any presentations I watch or educational courses I take, or books I read. Moreover, I now take much better in person notes -- I take them into "scratchpads" and then synthesize them later.

It's indispensable in meetings because I both take notes about the goals of meetings beforehand, take note of any important parts during them, and am able to succinctly review them afterwards as they relate to the original goals, and easily keep track of any action items.

I manage EVERYTHING this way now-- what I am currently working on, notes about what I've done in a day, notes about what I've done on the weekend, notes about books I want to read, movies I want to watch, have watched, fitness routines. It goes on.

At first it was a small but useful knowledge base, and a good plan for how to keep track of things better. Now it's a larger, and even more useful knowledge base, where due to review and organization the important concepts in it have mostly made its way into my long term memory. And the process of taking and using the notes has become a smooth and well-honed process. I keep the notes in dropbox so I have easy access to them on mobile also.

In short: I treat my personal knowledge base as if it were a coding project: using well organized text files. I am constantly adding to them and maintaining them. It is working very well for me.

Re: The software engineering notebook

#14
post #13

The commitment to taking good notes has been one of the best decisions of my life -- not just professionally. I use my standard text editor (Textmate 2), and have a "notes" project, with all manner of categories organized by folder. I take notes on articles I have read, take notes on any presentations I watch or educational courses I take, or books I read. Moreover, I now take much better in person notes -- I take th…

I'm fairly similar to you but not as maybe not as meticulous

One thing that wasn't working for me was storing TODO style things and "X I want to watch/read/learn/play/do" items in my notes. Eventually I found Trello and it seems a good fit for that style of task (for me)

Everything else is stored in my notes though, or sometimes in paper-based notebooks that I take pictures of occasionally for archiving.

Still need to get better at things I've done at the weekend/daily bullet points etc, I often forget or am too lazy

Re: The software engineering notebook

#16
post #13

The commitment to taking good notes has been one of the best decisions of my life -- not just professionally. I use my standard text editor (Textmate 2), and have a "notes" project, with all manner of categories organized by folder. I take notes on articles I have read, take notes on any presentations I watch or educational courses I take, or books I read. Moreover, I now take much better in person notes -- I take th…

Can you explain how you organize them? Been trying to do something similar but haven't gotten it quite right yet.

Re: The software engineering notebook

#18
post #15

Is there any opensource things that can be a software engineering notebook or journal that is easy to use and painless?

Not opensource but hard to beat Quiver: http://happenapps.com/ Edit: I take that back, Boostnote looks pretty good!

I've just given boostnote a quick tour, as a Quiver user I'm not so sure boostnotes is quite there yet, at least on feature parity.

There seems to be some UI slowdown on my machine too, whereas Quiver doesn't seem to suffer from that at all, and I have like 200+ note files in my Quiver repository!

Re: The software engineering notebook

#20
In Dropbox, I keep an annual logbook file for both work and home, just a text file (well, rtf). As I do things that I want to remember I did, I write a note, paste a command line or link, etc, under a line with the date on which I did/wrote/pasted. Over time I've built up a record of my activities, and a handy notebook for remembering how to do complicated things I seldom do. It also makes it easy to write up status reports when those are necessary.
Post reply on HN