I'd argue that a code journal isn't the right place to 'Keep track of decisions', because I think comments in the code or an issue tracker are a better place. This way, when multiple people work on the project, other people don't have to read your code journal.
I do agree with the rest of them, especially remembering what you were doing last. I've started keeping a to-do list that was more fine-grained than the issue tracker that we use, and I've noticed my efficiency go up.
Why not both?, to me the journal is more personal, those are notes for me and probably wouldn't make sense to other, you can write things like "remmember the dumb thing you did the last time", well, the last time maybe is another project so is not relevant to others in your current project. In code comments you "translate" the journal entry in a concise and understandable version of it. In the journal you also keep discarted, dumb, far-fetched ideas and you can write 5 pages if you want, I don't care about all your process in the code and definetly not 5 pages of it. I even think that write it up in the journal first will even make better comments in your code after articulate the idea in the journal.
Jacqui Read is an internationally-recognised software and enterprise architect, and author of Communication Patterns: A Guide for Developers and Architects.
Hi Tijmen,
Yes, I agree, when you are working in a team then things like decisions need to be accessible to all the team. Somewhere like Confluence or a wiki would be a good place, which is a bit like a shared Code Journal.
For personal projects, though, keeping notes of decisions in your Code journal is ideal.
For further actions, you may consider blocking this person and/or reporting abuse
We're a place where coders share, stay up-to-date and grow their careers.
I'd argue that a code journal isn't the right place to 'Keep track of decisions', because I think comments in the code or an issue tracker are a better place. This way, when multiple people work on the project, other people don't have to read your code journal.
I do agree with the rest of them, especially remembering what you were doing last. I've started keeping a to-do list that was more fine-grained than the issue tracker that we use, and I've noticed my efficiency go up.
Why not both?, to me the journal is more personal, those are notes for me and probably wouldn't make sense to other, you can write things like "remmember the dumb thing you did the last time", well, the last time maybe is another project so is not relevant to others in your current project. In code comments you "translate" the journal entry in a concise and understandable version of it. In the journal you also keep discarted, dumb, far-fetched ideas and you can write 5 pages if you want, I don't care about all your process in the code and definetly not 5 pages of it. I even think that write it up in the journal first will even make better comments in your code after articulate the idea in the journal.
Hi Tijmen,
Yes, I agree, when you are working in a team then things like decisions need to be accessible to all the team. Somewhere like Confluence or a wiki would be a good place, which is a bit like a shared Code Journal.
For personal projects, though, keeping notes of decisions in your Code journal is ideal.