1. 19
  1. 6

    I really like how the page reminds me of a log book.

    As a solo developer at the moment, I have been trying to keep a bug log in a text file as a lighter weight version of jira, though my focus is on retrospectives to help eliminate future defects. Two entries:

    Bug: Login still allowed after refund.
    Severity: Moderate.
    Impact: Tricky customers could get free access, though normal users would not notice.
    Defect: Values were not deleted from the table after stripe refund.
    Root Cause: Lack of testing due to laziness, test case could easily catch.
    Bug: F rating on https://www.ssllabs.com/ssltest/analyze.html
    Severity: Moderate.
    Impact: Customer data could be cracked by a determined attacker, affecting reputation.
    Defect: HAProxy SSL configuration was not set to a good standard.
    Root Cause: Lack of a release checklist with best practices.
    1. 3

      “Studies have shown”, and I have verified that it works for me, that writing things down helps memory consolidation. I solve a problem (or don’t solve it) and then collect all the links, summarize the relevant things and write it up. I may also do extra research while doing this. I remember things better (or at least remember that I solved something) after this exercise. It also helps me to finish writing.

      Now, I do this on a blog. I learn a lot from other folks coding blogs, so this is my way of giving back. But, it’s pretty public (A friend of mine told me “I couldn’t put myself out there like that”) and indeed when I get things wrong, it’s embarrassing, and some of my colleagues are not afraid to call me out in public on that, but the embarrassment is less than what you would think, and the upsides, for me, outweigh the self-consciousness factor.

      If I had to start over, I might do it anonymously, but I would keep it all the same.

      1. 2

        Off-topic for this article but relevant to your comment, I personally value your blog. Thank you for writing it!

        This in particular was great - মৌলিক: A prime number toy

      2. 3

        Although it’s simple enough to be added as an alias, I’d recommend using the function. The function re-evaluates date each time its run, while the alias only evaluates it when your bashrc or zshrc is evaluated.

        You can define your alias using single quotes and it’d have the same effect.

        alias lb='vim ~/logbook/$(date "+%Y-%m-%d").md'
        1. 3

          I started a discussion about journaling a few months ago. That resulted in some great suggestions for tools to do something like this. I have been doing it on and off now since.

          1. 2

            I have been using vim wiki to keep this kind of log for the last few months.

            Terrific tool, it supports both internal and external links, most of org mode features, can easily be tracked by your favorite VCS and even has a export to HTML feature.

            1. 1

              I am keeping mine in Evernote. I wanted to learn org-mode to do this, but in the meantime I bought something that came with an Evernote subscription and stayed with that since.

              1. 2

                Just came upon Simplenote the other day. I don’t know if I’ll start using it for this kind of work but for distributed note taking I believe it’s the solution for me.

                1. 2

                  You might want to reconsider Evernote in case you didn’t notice their update about employees being tasked with manual reviewing of notes.

                2. 1

                  I came across recently to plan files from John Carmack which are kind of similar to a log book.