Live data from Hacker News

The software engineering notebook

winterflower.github.io

81–90 of 143 posts

Re: The software engineering notebook

#81
post #50

I have a "notes" directory in dropbox. I use .md files, with a text editor that does some highlighting based upon the markdown. 95% of them go into what I call my "dev diary". Each day gets a new file. Any questions, answers, thoughts, etc. while programming or designing go in there. For searchability, I also add any reference Jira/Trello/etc ids. Beyond that, I have cheatsheets and checklists. Cheatsheets are short,…

What do you with screenshots or other graphics?

Re: The software engineering notebook

#82
post #23

Earlier quoted context omitted.

On the other hand, based on my personal experience, maintaining a constantly growing archive of things, be it notes, bookmarks, emails, etc. turns out to be not very useful. Also, it gradually becomes something that you spend more time on than on other things. I now prefer to be more spontaneous, try to minimize the number of things that drag me into the past, start things as if from scratch, "reset" myself, dismiss…

I had the same problem as you, but my solution was separating "notes" from future actions. My notes track knowledge, they are referenced as-needed so I store everything because there's low/no cost. I've also found that writing things down improves my recollection, so there's value even if I never reference the note again. My calendar / omnifocus track future actions, I minimize these and keep them very well curated -…

> no "todo", only "do"

I'm curious about what this means. What are "do" notes (as distinct from "todo" ones). If it means that don't calendar, and you just do that task immediately, how you plan and (more importantly) remember future tasks?

Re: The software engineering notebook

#83
Despite being primarily a computational scientist, I still keep a proper "dead tree" lab notebook. It's been invaluable, both in keeping my thoughts ordered, and also referencing decisions toward old projects.

Re: The software engineering notebook

#84
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…

Would you be willing to talk more about your experience? I too am very interested in this process, but have yet to find one that is successful for me. I would love to hear more about your process.

Re: The software engineering notebook

#85
post #57
post #47

Earlier quoted context omitted.

A script might finesse things a little more, but you could get a naive implementation of the timestamp behavior with something like: alias journal='vim + "/Users/username/journal/$(date +%Y)/$(date +%Y%m%d).md" -c "execute \"normal! Go$(date +%T)\ ========\ \" | startinsert "'

This command (as presented) is giving me issues with saving the file on my machine, not sure if it's specific to only me but figured I'd give you a heads-up!

Here's a nice hacked up version, note the mkdir -p that makes the directory if it doesn't exist. Also I changed the time from 24hr to more provincial 12hr w/ AM/PM Please be careful adding aliases if you aren't sure what' they're doing!

alias journal='mkdir -p /Users/insert_your_username_here_on_mac_on_linux_change_Users_to_home_on_windows_good_luck/journal/$(date +%Y)/; vim + "/Users/insert_your_username_here_on_mac_on_linux_change_Users_to_home_on_windows_good_luck/journal/$(date +%Y)/$(date +%Y-%m-%d).md" -c "execute \"normal! Go$(date +%r)\========\\" | startinsert "'

Re: The software engineering notebook

#86
post #23

Earlier quoted context omitted.

On the other hand, based on my personal experience, maintaining a constantly growing archive of things, be it notes, bookmarks, emails, etc. turns out to be not very useful. Also, it gradually becomes something that you spend more time on than on other things. I now prefer to be more spontaneous, try to minimize the number of things that drag me into the past, start things as if from scratch, "reset" myself, dismiss…

I had the same problem as you, but my solution was separating "notes" from future actions. My notes track knowledge, they are referenced as-needed so I store everything because there's low/no cost. I've also found that writing things down improves my recollection, so there's value even if I never reference the note again. My calendar / omnifocus track future actions, I minimize these and keep them very well curated -…

I think it helps to do only enough to be useful and not enough to be a productivity sink. I keep a general purpose plaintext file called notes and a handful of plaintext files specific to certain topics in ~/documents and that's it.

Re: The software engineering notebook

#87
post #12

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

I was looking at Boostnote earlier: https://boostnote.io/

+1 Boostnote! It's one of the few open source notebook apps I've used that I've actually enjoyed!

Re: The software engineering notebook

#88
I have a "things learned" section in Notes.app, mostly to avoid repeated fuckups and to become a better person. Some earlier example entries:

* Leave the office once you're really sure that deployment was successful

* Have timestamps in logs

* Before making your opinion public, make sure what you think is a mistake is in fact a mistake

* When you struggle with an issue, make sure the fix isn't right in front of you

* Make sure everything's set up for remote work; you don't want to hotfix some production issue at 2 AM, only to find out you can't access Git from home

* Other people's time is worth twice yours

Re: The software engineering notebook

#89
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…

Good god, man/woman. Do you have time to do anything else besides taking notes?

Re: The software engineering notebook

#90

Back in college, going for my BSEE degree, the professor or lab assistant were constantly stressing the need to record everything done at the bench in a log book with pages dated and signed. Part of this was to keep a history of lab experiments and remind you of what you did and/or learned. Really, however, it was to develop the habit to carry over into your professional career. There are many examples of this but th…

> dated and signed

What's the signature for?

Post reply on HN